Previous Topic: List Service Procedure Statements

Next Topic: &$LHOPT=ADD Statement


&$LHOPT=ACTION Statement

This statement indicates that a list entry has been selected for actioning. When the value of &$LHOPT is ACTION, you can use the list service procedure to perform any special processing that is required to apply an action on the list entry.

Read-Only Variables

This statement contains the following read-only variables:

&$LHOPT

This variable is set to ACTION.

&$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 next to the entry to be actioned.

&$LHENTID

This variable is set to the identifier of the entry selected by the user for actioning.

&$LHENTD

This variable is set to the data associated with the entry selected by the user for actioning.

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.

&$LHREBUILD

Use this variable to indicate whether the entry line is to be rebuilt. This variable can be set to YES or NO. If set to YES, all the attributes to be used to rebuild the entry line must be set to the appropriate values. The default is NO. This variable is cleared by the system before calling the service procedure for ACTION processing.

&$LHENTMSG

Use this variable to set a message that is to overlay the entry line. The offset and length used are those defined in the list definition. This variable is cleared by the system before calling the service procedure for ACTION processing.

&$LHREFRESH

Use this variable to indicate whether the list is to be refreshed. This variable can be set to YES or NO. If set to YES, variables &$LHREBUILD and &$LHENTMSG are ignored. The default is NO. This variable is cleared by the system before calling the service procedure for ACTION processing.

&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 mnemonic set in error

8

An error occurred; terminate the list