List Exit Procedure Interface › List Exit Procedure Statements › &$LHOPT=INIT Statement

&$LHOPT=INIT Statement

This statement indicates initialization of a list. When the value of &$LHOPT is INIT, you can use the list exit procedure to perform any special processing that is required to initialize the list.

Read-Only Variables

This statement contains the following read-only variables:

&$LHOPT

This variable is set to INIT.

&$LHLISTFMT

This variable is set to indicate the format of the list. This variable is set to one of the following values:

ACTION

An action list

MSELECT

A multiple select list

SSELECT

A single select list

NUMBERED

A numbered list

&$LHAPPLID

This variable is set to the ID of the application to which the list belongs.

&$LHLISTTYPE

This variable is set to the type of the list. This variable is set to one of the following:

PUBLIC

The list is a public list.

PRIVATE

The list is a private list.

&$LHLISTUSER

This variable is set to the user ID of the user who owns the list, if it is a private list.

&$LHLISTNAME

This variable is set to the name of the list.

&$LHDESC

This variable is set to the description of the list.

&$LHDATASRC

This variable is set to the data source defined for the list.

&$LHFMTFLDn

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.

&$LHATB*

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.

Modifiable Variables

This statement contains the following modifiable variables:

&$LHCRITTOTAL

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.

&$LHCRITn

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.

&$LHSUPPRESS

Use this variable to specify whether entries are to be suppressed from the list by this procedure during entry processing. Set this variable to YES if you want to suppress entries; otherwise, set this variable to NO (the default).

&$LHADDALLOW

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.

&$LHGETALL

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.

&SYSMSG

Use this variable to return a message. If an error occurs during special processing, this variable must be set to an error message.

Return Codes

The variable &RETCODE must be set by the list exit procedure to one of the following return codes:

0

Continue processing

8

An error occurred; terminate the list