Action=BUILD Class=FKA

CAS Programming Interface ($CACALL) › Action=BUILD Class=FKA

Action=BUILD Class=FKA

This statement builds a function key area. You can build the function key area by using a predefined one or from scratch. Your procedure should call the BUILD FKA function before displaying a panel.

This statement has the following format:

&CONTROL SHRVARS=($FK)
-EXEC $CACALL   OPT=ACTION
                ACTION=BUILD
                CLASS=FKA
                [NAME=‘ FKA=function key area’]

FKA=function key area: An optional parameter identifying the predefined function key area on which to base the new function key area.

Input Variables

This statement contains the following input variables:

&$FK1...&$FK24: The function key actions for any or all of the keys F1 to F24. Specify NOACT to inactivate and remove a function key from the function key area.
&$FKLAB1...&$FKLAB24: The labels that are displayed in the function key area (the bottom two lines of the displayed screen). Each label can be up to eight characters in length. If not specified, the label for a key defaults to the first word of the key’s action.
&$FKS1...&$FKS24: These variables are used internally by the function. Do not alter the values of these variables.
&$FKSLAB1...&$FKSLAB24: These variables are used internally by the function. Do not alter the values of these variables.
&$FKOPTS: This variable is used internally by the function. Do not alter the value of this variable.

Return Variables

This statement contains the following return variables:

&$FK1...&$FK24

The function key actions for keys F1 to F24.

&$FKLAB1...&$FKLAB24

The function key labels for keys F1 to F24.

&$FKS1...&$FKS24

These variables are used internally by the function. Do not alter the values of these variables.

&$FKSLAB1...&$FKSLAB24

These variables are used internally by the function. Do not alter the values of these variables.

&$FKOPTS

This variable is used internally by the function. Do not alter the value of this variable.

&$FKA1

Function key area line 1.

&$FKA2

Function key area line 2.

Note: Depending on the user’s current function key area display option, &$FKA1 and &$FKA2 can contain F1 through F12, F13 through F24, or nothing.

&SYSMSG

System message. Contains the error message (for return code 8).

Feedback Codes

If a return code of 8 is set, then additional information is available as one of the following feedback codes, set in &$CAFDBK:

8: Processing error
10: Nesting level exceeded

Example

The following statements build a function key area by using the predefined function key area $CAADD, explicitly setting F5 to HISTORY and F6 to TEXT, and disabling F7 and F11:

&$FK5 = HISTORY
&$FK6 = TEXT
&$FK7 = NOACT
&$FK11 = NOACT
&CONTROL SHRVARS=($FK)
-EXEC $CACALL   OPT=ACTION +
                ACTION=BUILD +
                CLASS=FKA +
                NAME=‘FKA=$CAADD’

Predefined Function Key Areas

The function keys described in this topic apply to the following predefined function key areas:

$CAADD
$CABRO
$CADEL
$CAUPD
$IMADD
$IMBRO
$IMDEL
$IMUPD

You can use the following function keys in these areas:

F1 (HELP)

Displays Help.

F2 (SPLIT)

Creates a new session.

F3 (FILE, EXIT, or CANCEL)

In $CAADD, $CAUPD, $IMADD, and $IMUPD: Files your work.
In $CABRO, $IMBRO, and $IMDEL: Exits or cancels without saving.

F4 (SAVE)

Saves your work (only on $CAADD and $CAUPD).

F5 (HISTORY)

Displays history (only on $IMBRO and $IMUPD).

F6 (TEXT)

Displays text (only on $IMADD, $IMBRO, and $IMUPD).

F7 (BACKWARD)

Displays previous page in multi-page panels.

F8 (FORWARD)

Displays next page in multi-page panels.

F9 (SWAP)

Toggles between multiple sessions.

F10 (CANCEL)

Cancels without saving (only on $IMADD and $IMUPD).

F12 (CANCEL)

Cancels without saving.