gtpg2m5dGeneral Macros

UXMAC-Define Multiple User Exit Interface

This general macro defines and generates the code and tables that are necessary to support the use of a user exit by multiple functions.

Format




START
Defines the start of the multiple function user exit interface build process.

EXIT=exitname
Specifies the name of the exit for which this build process is being executed, where exitname is the 1- to 4- character name defined in DCTUCL.

PARMS=reg
Specifies the register (or registers) that are not to be reset from the stack because they contain data. When more than one register is specified, all the registers must be in parentheses.

WKAREA=size
Specifies, in bytes, a user work area to be allocated on the current stack. A label to access this area is generated in the form name_WKA, using the name specified with the EXIT parameter.

BUILD
Defines the information associated with a single function. The order of the UXMAC macro statements with the BUILD parameter specified dictates the order in which the functions will receive control when active.

NAME=name
Specifies the name of the requested function, where name is one of the equate names defined in IUXEQ.

ROUTINE=lbl
Specifies the name of the routine (entry point) that will process the specified function.

TYPE
Specifies the type of addressability the stub routine has to the called routine identified by the ROUTINE parameter.

EXT
Specifies that the address of the called routine is located in a different CSECT than this routine. The address is resolved by a V-type constant (Vcon).

INT
Specifies that the address of the called routine is within the current CSECT. The address is resolved by an address constant (Adcon).

RCRTN=rtnlbl
Specifies the name of the routine that will process a return code from the specified function.

RCTYPE
Specifies the type of addressability the stub routine has to the called routine identified by the RCRTN parameter. This parameter is required when RCRTN is coded.

END
Defines the end of the definition interface macros and initiates the generation of executable code and tables.

SET
Turns on the multiple-function indicator in a parameter list entry.

NAME=name
One of the equate names, defined in IUXEQ, of the function to be set on.

WKREG=wkreg
Specifies an even-odd pair of registers to use as work registers. The even register must be specified.

Entry Requirements

None.

Return Conditions

None.

Programming Considerations

Examples