Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWMQCXIT macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,ACTION=QDEL
- ,ACTION=NULL
- A required parameter, which indicates the type of action requested.
The exit should make an explicit check for the action indicated to
anticipate the introduction of new values in later releases.
- ,ACTION=QDEL
- indicates that exit is being called for the deletion of a previously
queued work element. The exit will only be called once per queued
work element. If the exit should end abnormally, the system will not
invoke the exit again for the same queued work element. In the event
of an abnormal termination of the exit routine, the system may chose
to call the exit for any remaining queued work elements, or may chose
to discontinue use of the exit upon some threshold number of errors.
- ,ACTION=NULL
- indicates that no exit is to be called. The exit routine need
not check for this action.
- ,APPLENV=applenv
- A required input parameter, which contains the application environment
name associated with the queued work request or blanks if not available.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 32-character field.
- ,ETOKEN=etoken
- A required input parameter, which contains the Enclave token
associated with the work request at the time the work request was
queued or binary zeros when the system knows the Enclave no longer
exists or the system no longer knows which Enclave was associated
with the work request.
To code: Specify
the RS-type address, or address in register (2)-(12), of an 8-character
field.
- ,MF=S
- ,MF=(L,list addr)
- ,MF=(L,list addr,attr)
- ,MF=(L,list addr,0D)
- ,MF=(E,list addr)
- ,MF=(E,list addr,COMPLETE)
- An optional input parameter that specifies the macro form.
Use
MF=S to specify the standard form of the macro, which builds an inline
parameter list and generates the macro invocation to transfer control
to the service. MF=S is the default.
Use MF=L to specify the
list form of the macro. Use the list form together with the execute
form of the macro for applications that require reentrant code. The
list form defines an area of storage that the execute form uses to
store the parameters. Only the PLISTVER parameter may be coded with
the list form of the macro.
Use MF=E to specify the execute
form of the macro. Use the execute form together with the list form
of the macro for applications that require reentrant code. The execute
form of the macro stores the parameters into the storage area defined
by the list form, and generates the macro invocation to transfer control
to the service.
- ,list addr
- The name of a storage area to contain the parameters. For MF=S
and MF=E, this can be an RS-type address or an address in register
(1)-(12).
- ,attr
- An optional 1- to 60-character input string that you use to
force boundary alignment of the parameter list. Use a value of 0F
to force the parameter list to a word boundary, or 0D to force the
parameter list to a doubleword boundary. If you do not code attr,
the system provides a value of 0D.
- ,COMPLETE
- Specifies that the system is to check for required parameters
and supply defaults for omitted optional parameters.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- An optional input parameter that specifies the version of the
macro. PLISTVER determines which parameter list the system generates.
PLISTVER is an optional input parameter on all forms of the macro,
including the list form. When using PLISTVER, specify it on all macro
forms used for a request and with the same value on all of the macro
forms. The values are:
- IMPLIED_VERSION, which is the lowest
version that allows all parameters specified on the request to be
processed. If you omit the PLISTVER parameter, IMPLIED_VERSION
is the default.
- MAX, if you want the parameter list to be
the largest size currently possible. This size might grow from release
to release and affect the amount of storage that your program needs.
If
you can tolerate the size change, IBM recommends that you always specify
PLISTVER=MAX on the list form of the macro. Specifying MAX ensures
that the list-form parameter list is always long enough to hold all
the parameters you might specify on the execute form, when both are
assembled with the same level of the system. In this way, MAX ensures
that the parameter list does not overwrite nearby storage.
- 0, if you use the currently available parameters.
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0
- QMGR_EXIT@=qmgr_exit@
- A required input parameter that contains the address of the
Queue Manager Connect Exit to be invoked.
To code: Specify
the RS-type address, or address in register (2)-(12), of a pointer
field.
- ,RETCODE=retcode
- An optional output parameter into which the return code is to
be copied from GPR 15. If you specify 15, GPR15, REG15, or R15 (within
or without parentheses), the value will be left in GPR 15.
To code: Specify the RS-type address of a
fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or
(R15).
- ,RSNCODE=rsncode
- An optional output parameter into which the reason code is to
be copied from GPR 0. If you specify 0, 00, GPR0, GPR00, REG0, REG00,
or R0 (within or without parentheses), the value will be left in GPR
0.
To code: Specify the RS-type address
of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00),
REG0), (REG00), or (R0).
- ,SECUSER=NO
- ,SECUSER=YES
- An optional parameter, which specifies whether the security
environment of a user was associated with the queued work request.
The default is SECUSER=NO.
- ,SECUSER=NO
- No security environment was to be established.
- ,SECUSER=YES
- The specified userid was to be used to establish a security
environment.
- ,USERDATA=userdata
- A required input parameter, which contains data passed to Queue
Insert. The format is undefined to MVS.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 16-character
field.
- ,USERID=userid
- When SECUSER=YES is specified, a required input parameter, which
contains the requester's userid.
To code: Specify
the RS-type address, or address in register (2)-(12), of an 8-character
field.
|