Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on the HZSPWRIT macro invocation. The name must conform to the rules for an ordinary assembler language symbol.
- BUFFER=buffer
- A required input parameter, area that contains the data to be
written. The buffer should be in the same key as the caller.
To code: Specify the RS-type address, or address in register (2)-(12), of a character field.
- ,DATALEN=datalen
- A required input parameter that contains the number of bytes of
data from the buffer to be written.
To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.
- ,HANDLE=handle
- When REMOTE=YES is specified, a required input parameter that
specifies a handle (token) that identifies the check. This handle
was returned via the HANDLE parameter of the HZSADDCK macro for a
REMOTE=YES REXX=NO check. It is provided in REXX variable HZS_HANDLE
for a REMOTE=YES REXX=YES check.
To code: Specify the RS-type address, or address in register (2)-(12), of a 16-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
- ,REMOTE=NO
- ,REMOTE=YES
- An optional parameter, which identifies the locale of the check.
The default is REMOTE=NO.
- ,REMOTE=NO
- indicates that the check runs locally in the address space of IBM Health Checker for z/OS®.
- ,REMOTE=YES
- indicates that the check runs remotely, in an address space other than that of IBM Health Checker for z/OS.
- ,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).
- ,REXX=NO
- ,REXX=YES
- When REMOTE=YES is specified, an optional parameter, which indicates
if this is a REXX check. The default is REXX=NO.
- ,REXX=NO
- indicates that the check is not a REXX check.
- ,REXX=YES
- indicates that the check is a REXX check.
- ,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).
- ,SECCHECK=UNAUTH
- ,SECCHECK=ALL
- An optional parameter that indicates whether to do RACF® security checks. The default is SECCHECK=UNAUTH.
- ,SECCHECK=UNAUTH
- that indicates to do RACF security checks only when the caller is unauthorized (not supervisor state, not system key, not APF-authorized).
- ,SECCHECK=ALL
- that indicates to do RACF security checks in all cases. If RACF does not grant authority, the request is rejected.