Previous Topic: PurposeNext Topic: Return Code


Arguments

The following table gives a brief description of each of the arguments.

Name

Input/ Output

Description

RUNTIME-PARM1

input

DFHEIBLK (CICS)

I/O PCB (IMS)

Emulated I/O PCB (TSO)

RUNTIME-PARM2

input

DFHCOMMAREA (CICS)

Alternate I/O PCB (IMS)

Emulated Alt I/O PCB (TSO)

TIRIEXS-CMCB

input/output

A structure containing the following items:

TIRIEXS-RETURN-CODE

output

The return value indicating what action the exit wants the runtimes to take for the current screen field.

RC-ACCEPT - The exit took no action for the current screen field and accepts the results of Gen's validation. Normal processing will continue.

RC-REJECT - The exit requests that the value input in the current screen field be marked in error. This return code should only be used for screen fields that have an edit pattern defined or for screen fields mapped to view attributes that are mandatory or that have permitted values defined.

RC-REPROCESS - The exit modified the value that was input in the current screen field (INPUT-VALUE) and requests that this modified input value be revalidated.

RC-EXIT-VALUE - The exit modified the value that was stored in the view attribute mapped to the current screen field (ATTRIBUTE-VALUE) and requests that this modified attribute value replace the value that was determined by Gen. This modified attribute value will not be revalidated.

RC-ERASE - The exit requests that the value input in the current screen field be erased.

This return code should not be used for screen fields mapped to mandatory view attributes.

TIRIEXS-STATUS-CODE1

input

The status of the validation performed by Gen for the current screen field.

SC-OK - The current screen field's value is considered to be valid by Gen's validation routines.

SC-FAIL-PENDING - The current screen field's value is considered to be invalid by Gen's validation routines.

TIRIEXS-STATUS-CODE2

input

The processing status of the current screen field.

SC-FIRST-PASS - This indicates this is the first time the exit has been called for the current screen field.

SC-REENTER - This indicates the exit has been called previously for the current screen field and the exit requested that the field be reprocessed (RC-REPROCESS).

TIRIEXS-ERROR-MSG-NUMBER

input

The error message number determined by Gen's validation routines prior to calling the exit.

INPUT-VALUE

input/output

The value entered in the current screen field. This value should be modified by the exit if the exit returns RC-REPROCESS.

FIELD-LENGTH

input

The length of the current screen field.

FIELD-FILL-CHAR

input

The fill character defined for current screen field.

FIELD-BEGIN-ROWCOL

input

The beginning row and column of the current screen field.

FIELD-END-ROWCOL

input

The ending row and column of the current screen field.

ATTRIBUTE-VALUE

input/output

The value to be stored in the view attribute mapped to the current screen field. This value should be modified by the exit if the exit returns RC-EXIT-VALUE.

ATTRIBUTE-LENGTH

input

The length of the view attribute mapped to the current screen field.

ATTRIBUTE-TYPE

input

The datatype of the view attribute mapped to the current screen field.

ATTR-TEXT - A fixed-length text attribute.

ATTR-VARCHAR - A varying-length text attribute.

ATTR-NUMERIC - A numeric attribute.

ATTRIBUTE-DECIMAL-PLACES

input

The number of decimal places defined for the view attribute mapped to the current screen field.

ATTRIBUTE-CASE-SENSITIVE

input

The case sensitivity property defined for the view attribute mapped to the current screen field.

MAPNAME

input

The name of the current screen.

MODNAME

input

The modname of the current screen.

DIALECT-NAME

input

The name of the dialect used by the current screen.

DECIMAL-INDICATOR

input

The character used to represent the decimal place in the current dialect.

THOUSANDS-INDICATOR

input

The character used to represent the thousands separator in the current dialect.

CURRENCY-INDICATOR

input

The character used to represent the currency symbol in the current dialect.

TXT-ORIENTATION

input

The orientation of text fields in the current dialect.

NUM-ORIENTATION

input

The orientation of numeric fields in the current dialect.

EDIT-PATTERN-CLASS

input

The edit pattern class for the current screen field.

EPAT-ALPHANUMERIC - An alphanumeric edit pattern.

EPAT-NUMERIC - A numeric edit pattern.

EPAT-DATE - A date edit pattern.

EPAT-TIME - A time edit pattern.

EPAT-TIMESTAMP - A timestamp edit pattern.

EPAT-NONE - No edit pattern is defined for the current screen field.

FILLER

input

Filler, for future use

GLOBDATA

input

Global data, used internally