|
|
|
This statement indicates that a list entry is to be retrieved. When the value of &$LHOPT is GET, you can use the list service procedure to perform any special processing that is required to get a list entry.
This statement contains the following read-only variables:
This variable is set to GET.
This variable is set to indicate the format of the list. This variable is set to one of the following values:
An action list
A multiple select list
A single select list
A numbered list
This variable is set to the ID of the application to which the list belongs.
This variable is set to the type of the displayed list. This variable is set to one of the following:
The list is a public list.
The list is a private list.
This variable is set to the user ID of the user who owns the list, if it is a private list.
This variable is set to the name of the list.
This variable is set to the description of the list.
This variable is set to the data source defined for the list.
This variable is set to the number of &$LHCRIT variables that contain criteria. The value of this variable is in the range 0 to 9999.
These variables are set to the criteria which the service procedure uses to determine the entries to be included in the list, if variable &$LHCRITTOTAL is greater than zero; n is in the range 1 to the value of &$LHCRITTOTAL.
This variable is set to the sort expression defined for the list.
These variables are set to the names of the real fields defined for the list; n is in the range 1 to the number of real fields defined.
These variables are set to the panel attributes that can be used to set the intensity, color, and highlighting for data within an entry line.
This variable is set to indicate whether the list panel timed out. This variable is set to one of the following values:
The list panel did not time out.
The list panel timed out.
This variable is set to indicate whether the REFRESH command was executed by the user. This variable is set to one of the following values:
The REFRESH command was not executed.
The REFRESH command was executed.
This variable is set to indicate the retrieval direction. This variable is set to one of the following values:
Get an entry in a forward direction.
Get an entry in a backward direction.
Get the entry with an identifier that matches the value set in &$LHSKIP, if not found, get the first entry which has an identifier less than the value set in &$LHSKIP.
If the value of this variable is null, get the entry identified in &$LHENTID.
This variable is set to indicate whether all entries for the list are retrieved during initialization processing for the list. This variable is set to one of the following values:
Entries are retrieved as required for display on the list.
All entries for the list are retrieved during initialization processing for the list.
This variable is set to indicate whether entries will be suppressed from the list by this procedure when getting entries, by the list exit procedure during entry processing, or by both procedures.
This variable is set to indicate the number of entries to be skipped if &$LHDIRECTION is set to FWD or BKWD. If &$LHDIRECTION is set to LOCATE, it is set to the identifier of the entry to be located, that is, the locate string entered by the user.
This variable is set to indicate the number of entries that are to be retrieved in a forward direction until the list is displayed.
This statement contains the following modifiable variables:
These variables contain service procedure data as set by the caller of $CACALL; c is between 0 and 5 alphanumeric and/or national characters. These variables are never set or cleared by the system and must be completely managed by your installation-written NCL procedures.
Use this variable to specify the number of list entries to get for display. This variable can be set to the total number of entries to be displayed on the list when &$LHOPT is set to GET and &$LHRFRESHCMD or &$LHREFRESH is set to YES. The value of this variable is displayed in the top right corner of the list.
This variable is set to the identifier of the entry from which to start reading. If &$LHDIRECTION and &$LHSKIP are null, get the entry that has an identifier that matches the value of this variable and if not found return NOT FOUND condition. If this variable is null and &$LHDIRECTION is set to FWD or BKWD, get the first or last entry respectively. You must set this variable to the identifier of the entry returned.
This variable is set to the data associated with the entry identified in &$LHENTID. This variable can be set to the data to be associated with the entry returned.
Use this variable to specify the position of the entry being returned within the list. If &$LHSUPPRESS is not set to YES and the Get all Entries field in the list definition is set to NO, the value of this variable is displayed in the top right corner of the list in front of the total.
Use this variable to return a message. If an error occurs during special processing, this variable must be set to an error message.
The variable &RETCODE must be set by the list service procedure to one of the following return codes:
Continue processing
Entry not found
An error occurred; terminate the list
| Copyright © 2008 CA. All rights reserved. |
|