List Service Procedure Interface › List Service Procedure Statements › &$LHOPT=ALL Statement

&$LHOPT=ALL Statement

This statement indicates that the user has executed the ALL command. When the value of &$LHOPT is ALL, you can use the list service procedure to perform any special processing that is required for ALL command processing.

Read-Only Variables

This statement contains the following read-only variables:

&$LHOPT

This variable is set to ALL.

&$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.

&$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.

&$LHSORT

This variable is set to the sort expression 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.

&$LHACTION

This variable is set to the mnemonic entered by the user as the parameter on the ALL command.

Modifiable Variables

This statement contains the following modifiable variables:

&$LHSPDc

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.

&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 service procedure to one of the following return codes:

0

Continue processing

4

Request denied or error; redisplay the list with the error message

8

An error occurred; terminate the list