|
|
|
This statement indicates initialization of a list. When the value of &$LHOPT is INIT, you can use the list service procedure to perform any special processing that is required before the display of the list.
This statement contains the following read-only variables:
This variable is set to INIT.
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 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 through 9999.
These variables are set to the criteria which the service procedure uses to determine the entries to include 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 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.
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. Set this variable to YES if you want to suppress entries; otherwise, set this variable to NO (the default).
This variable is set to the Add Allowed setting defined for the list. It is set to YES if the list supports the ADD command, and it is set to NO if the list does not support the ADD command. The value of this variable can be modified to YES or NO. This variable is ignored if the list is a single or multiple select, or numbered list.
This variable is set to the Get All Entries setting defined for the list. It is set to YES if all entries for the list are retrieved during initialization processing for the list. It is set to NO if entries are retrieved as required for display on the list. The value of this variable can be modified to YES or NO.
This variable is set to indicate whether entries for the list can be built in a backwards direction when processing the BACKWARD command—this means that the entries are retrieved in a backwards direction. Set this variable to YES if entries can be built in a backwards direction; otherwise, set this variable to NO. The default value is YES.
This variable must be set to the mnemonics of the supported actions in the format mmm,mmm,mmm....
This variable can be set to the mnemonics of the actions that are to be confirmed before the action occurs, in the format mmm,mmm,mmm....
Use this variable to specify the total number of entries to be displayed on the list. The value of this variable is displayed in the top right corner of the list if &$LHSUPPRESS is not set to YES.
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
No entries found; terminate the list
An error occurred; terminate the list
| Copyright © 2008 CA. All rights reserved. |
|