XSZBRQ

XSZBRQ is invoked before a FEPI command is executed; the input parameters for the command are passed to the exit program.

The majority of the information passed is read-only, but you can write a program to update specific parameters. FEPI does not check the validity of the new values for the updated parameters. In addition, your exit program can decide whether the request is to be processed or bypassed. You could use XSZBRQ, for example, to log commands, to bypass commands that violate the conventions of your installation, or to reroute commands by changing their specified targets or pools.

Together, UEPSZALP and UEPSZALT contain the information necessary to initiate a conversation.

When invoked

Invoked by FEPI before a FEPI command runs, but after syntax and semantic checking.

Exit-specific parameters

UEPSZACT

A 2-byte field that identifies the command. The values are given in Table 1.

UEPSZCNV

An 8-character field containing the conversation ID (CONVID) for the command. Applicable on FEPI ALLOCATE, SEND, RECEIVE, CONVERSE, EXTRACT, ISSUE, START, and FREE commands.

UEPSZALP

An 8-character field containing the name of the pool (POOL). Modifiable and applicable on FEPI ALLOCATE and CONVERSE commands.

UEPSZALT

An 8-character field containing the name of the target (TARGET). Modifiable and applicable on FEPI ALLOCATE and CONVERSE commands.

UEPSZTIM

Fullword binary field containing the timeout value (TIMEOUT). Modifiable and applicable on FEPI ALLOCATE, RECEIVE, CONVERSE, and START commands.

UEPSZSND

Address of the ‘send’ data-area (FROM). Applicable on FEPI CONVERSE and SEND commands.

UEPSZSNL

Fullword binary field containing the length of the ‘send’ data (FROMFLENGTH, FLENGTH). Applicable on FEPI CONVERSE and SEND commands.

UEPSZSTT

A 4-character field containing the transaction ID (TRANSID). Modifiable and applicable on FEPI START commands.

UEPSZSTM

A 4-character field containing the terminal ID (TERMID). Modifiable and applicable on FEPI START commands.

UEPSZSNK

A 1-bit flag field indicating whether data is in key stroke format (KEYSTROKE). Applicable on FEPI CONVERSE FORMATTED and SEND FORMATTED commands. It can contain the following values:

UEPSZSNK_OFF: Not key stroke format.
UEPSZSNK_ON: Key stroke format.

UEPSZSNE

A 1-character field containing the key stroke escape character (ESCAPE). Applicable on FEPI CONVERSE FORMATTED and SEND FORMATTED commands.

Return codes

UERCNORM: Continue processing.
UERCBYP: Do not process the request; return INVREQ to the application.
Note: Your exit program cannot bypass events (like CICS shutdown or end-of-task).

XPI calls

Do not use XPI calls.