sysVar.eventKey

The system variable sysVar.eventKey identifies the key that the user pressed to return a form to an EGL text program. The value is reset each time that the program runs the converse statement.

If the EGL code has no input form, the initial value of sysVar.eventKey is ENTER.

The following values are valid (whether uppercase, lowercase, or a combination):

• ENTER

• BYPASS (which refers to any of the keys that were specified as bypass keys for the form; or if none were specified for the form, any of the keys that were specified as bypass keys for the formGroup; or if none were specified for the formGroup, any of the keys that were specified as bypass keys for the program)

• PA1 through PA3

• PF1 through PF24 (as also used for F1 through F24)

• PAKEY (for any PA key)

• PFKEY (for any PF or F key)

Note: PA keys are always treated as bypass keys.

You can use sysVar.eventKey as an operand in an if or while statement.

The characteristics of this system variable are as follows:

Primitive type

CHAR

Data length

1

Value saved across segments

No

sysVar.eventKey is not valid in a batch program.

Example

The comparison operator for sysVar.eventKey is either is or not, as in this example:

  if (sysVar.eventKey IS PF3)
    exit program(0);
  end

Related reference
Logical expressions