Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the HZSCPARS macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,CPARAREA=cpararea

When REQUEST=CHECKPARM is specified, a required input parameter that is the check parse area (CParArea), the address of which was returned by the PARSE request.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,CPARAREA=cpararea

When REQUEST=CHECKNOTPROC is specified, a required input parameter that is the check parse area (CParArea), the address of which was returned by the PARSE request.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,CPARAREA=cpararea

When REQUEST=FREE is specified, a required input parameter that is the check parse area (CParArea) to be freed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,CPARAREAADDR=cparareaaddr

When REQUEST=PARSE is specified, a required output parameter that is to contain the address of the check parse area (CParArea).

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,FIRSTVALUEADDR=firstvalueaddr

When REQUEST=CHECKPARM is specified, an optional output parameter that is to contain the address of the first CParKeywordValueEntry area of the parameter, or 0 if there are none. A value of 0 is expected when the format is positional (bit CparAreaFormatPositional is on. This should be used except when you are verifying that the number of values that can be specified is 0.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,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.

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,KEYENTRY=keyentry

When REQUEST=CHECKDEC is specified, a required input parameter that is the CParKeywordEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYENTRY=keyentry

When REQUEST=CHECKHEX is specified, a required input parameter that is the CParKeywordEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYENTRY=keyentry

When REQUEST=CHECKCHAR is specified, a required input parameter that is the CParKeywordEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYENTRYADDR=keyentryaddr

When REQUEST=CHECKPARM is specified, an optional output parameter that is to contain the address of the CParKeywordEntry of the parameter.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,KEYINFOAREA=keyinfoarea

When REQUEST=CHECKDEC is specified, a required input/output parameter, of the KeywordInfo area that is built. It need not be initialized prior to the call

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYINFOAREA=keyinfoarea

When REQUEST=CHECKHEX is specified, a required input/output parameter, of the KeywordInfo area that is built. It need not be initialized prior to the call

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYINFOAREA=keyinfoarea

When REQUEST=CHECKCHAR is specified, a required input/output parameter, of the KeywordInfo area that is built. It need not be initialized prior to the call. At this time, there is no output information within this area that you will need.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYVALUEENTRY=keyvalueentry

When REQUEST=CHECKDEC is specified, a required input parameter that is the CParKeywordValueEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYVALUEENTRY=keyvalueentry

When REQUEST=CHECKHEX is specified, a required input parameter that is the CParKeywordValueEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,KEYVALUEENTRY=keyvalueentry

When REQUEST=CHECKCHAR is specified, a required input parameter that is the CParKeywordValueEntry of the value to be processed.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,MAXLEN=maxlen

When REQUEST=CHECKCHAR is specified, a required input parameter that is the maximum length allowed.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,MAXVALUEDEC=maxvaluedec

When REQUEST=CHECKDEC is specified, a required input parameter that is the maximum decimal value allowed. This is a numeric value. When the number has a percent suffix, a value in the range 1-100 is accepted regardless of what is specified with this parameter. The value is treated as an unsigned number, and a value >= 2**63 will be treated as 2**63-1.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MAXVALUEHEX=maxvaluehex

When REQUEST=CHECKHEX is specified, a required input parameter that is the maximum hexadecimal value allowed. This is a numeric value.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MAXVALUES=maxvalues

When REQUEST=CHECKPARM is specified, a required input parameter that indicates the maximum number of values that can be specified.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,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.

,MINLEN=minlen

When REQUEST=CHECKCHAR is specified, a required input parameter that is the minimum length allowed.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,MINVALUEDEC=minvaluedec

When REQUEST=CHECKDEC is specified, a required input parameter that is the minimum decimal value allowed. This is a numeric value. When the number has a percent suffix, a value in the range 1-100 is accepted regardless of what is specified with this parameter. The value is treated as an unsigned number.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MINVALUEHEX=minvaluehex

When REQUEST=CHECKHEX is specified, a required input parameter that is the minimum hexadecimal value allowed. This is a numeric value.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,MINVALUES=minvalues

When REQUEST=CHECKPARM is specified, a required input parameter that indicates the minimum number of values that can be specified.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,NEXTVALUEADDR=nextvalueaddr

When KEYVALUEENTRY=keyvalueentry and REQUEST=CHECKDEC are specified, a required output parameter that is to contain the address of the next CParKeywordValueEntry area of the parameter, or 0 if there are none.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,NEXTVALUEADDR=nextvalueaddr

When KEYVALUEENTRY=keyvalueentry and REQUEST=CHECKHEX are specified, a required output parameter that is to contain the address of the next CParKeywordValueEntry area of the parameter, or 0 if there are none.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,NEXTVALUEADDR=nextvalueaddr

When KEYVALUEENTRY=keyvalueentry and REQUEST=CHECKCHAR are specified, a required output parameter that is to contain the address of the next CParKeywordValueEntry area of the parameter, or 0 if there are none.

To code: Specify the RS-type address, or address in register (2)-(12), of a pointer field.

,PARM=parm

When REQUEST=PARSE is specified, a required input parameter that is the input parameter. The input parameter has a limited acceptable character set:

Alphanumeric
Special ('@', '#', '$')
Additional ('.', '*', '?', '_', '/', '-', '%')
Delimiters ('=', '(', ')', ',', blank)
Single quote (within a quoted string, any character is accepted)

A null parameter can be denoted by consecutive commas with no non-blank non-comment text in between (or by a leading comma). For example, the string "A,,B" represents 3 positional parameters, the first being "A", the second being null, and the third being "B".

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,PARMFORMAT=EITHER

,PARMFORMAT=KEYWORD

When REQUEST=PARSE is specified, an optional parameter, which identifies the allowed format of the input. The default is PARMFORMAT=EITHER.

,PARMFORMAT=EITHER: indicates that either positional or keyword format is OK. An example of positional format is ("Val1,...,ValN"). Examples of keyword format are "key1(val1),...,keyN(valN)" and "Key1=val1,...,keyN=valN". Note that within an input string there cannot be a mixture of keyword and positional format.
,PARMFORMAT=KEYWORD: indicates that only keyword format is allowed.

,PARMLEN=parmlen

When REQUEST=PARSE is specified, a required input parameter that is the length of the input parameter.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,PARMNAME=parmname

When REQUEST=CHECKPARM is specified, a required input parameter that is the name of the parameter to be checked.

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,PARMNAME=parmname

When REQUEST=CHECKDEC is specified, a required input parameter that is the name of the parameter being processed

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,PARMNAME=parmname

When REQUEST=CHECKHEX is specified, a required input parameter that is the name of the parameter being processed

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,PARMNAME=parmname

When REQUEST=CHECKCHAR is specified, a required input parameter that is the name of the parameter being processed

To code: Specify the RS-type address, or address in register (2)-(12), of a 16-character field.

,PARMPOS=parmpos

,PARMPOS=NOT_POS

When REQUEST=CHECKPARM is specified, an optional input parameter that indicates to return the Nth parameter. The default is NOT_POS. that indicates the parameter is not positional, so use the name.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,PERCENTOK=YES

,PERCENTOK=NO

When REQUEST=CHECKDEC is specified, a required parameter that indicates if a percent suffix is to be accepted

,PERCENTOK=YES: indicates that a percent suffix is OK.
,PERCENTOK=NO: indicates that a percent suffix is not OK.

,PERCENTVALUE=percentvalue

,PERCENTVALUE=NOT_USED

When PERCENTOK=YES and REQUEST=CHECKDEC are specified, an optional input parameter that is the value to which the specified decimal parameter value when it ends with "%" will be applied. This is a numeric value. This value is multipled by the percentage and the result is returned (multiply by N and then divide by 100). The default is NOT_USED.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character field.

,PERCENT10000=NO

,PERCENT10000=YES

When PERCENTOK=YES and REQUEST=CHECKDEC are specified, an optional parameter that indicates if the percentage may be up to 10000. The default is PERCENT10000=NO.

,PERCENT10000=NO: indicates that the percentage value has a maximum value of 100.
,PERCENT10000=YES: indicates that the percentage value may be up to 10000.

,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.

REQUEST=PARSE

REQUEST=CHECKPARM

REQUEST=CHECKNOTPROC

REQUEST=CHECKDEC

REQUEST=CHECKHEX

REQUEST=CHECKCHAR

REQUEST=FREE

A required parameter, which identifies the type of request.

REQUEST=PARSE: Parse the input string. Note that if the return code from this function is not zero, you should avoid using the other request types, as no valid data will have been returned.
REQUEST=CHECKPARM: Check a particular parameter for number of values
REQUEST=CHECKNOTPROC: Check for parameters that were not processed
REQUEST=CHECKDEC: Check a particular parameter value as a decimal number. The parameter can be a decimal number or a decimal number followed by a suffix of K (multiply by 2**10), M (multiply by 2**20), G (multiply by 2**30), T (multiply by 2**40) P (multiply by 2**50), E (multiply by 2**60). The decimal number is limited to a length of 10 characters and a maximum value of 2147483647. The value that is checked against is the decimal number multiplied by (when a suffix is provided) the value indicated by the suffix.
REQUEST=CHECKHEX: Check a particular parameter value as a hexadecimal number
REQUEST=CHECKCHAR: Check a particular parameter value as character data
REQUEST=FREE: Free the storage area. Note that, for a REMOTE=NO check if you do not use this function, the system will free this area for you upon return from the check routine call in which the area was obtained. Thus for a REMOTE=NO check you must use REQUEST=FREE from the check routine call that issued REQUEST=PARSE only.

,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).

,TOUPPER=YES

,TOUPPER=NO

When REQUEST=PARSE is specified, a required parameter, which indicates if the input parameter string is to be translated to upper case before processing.

,TOUPPER=YES: indicates to translate to upper case.
,TOUPPER=NO: indicates not to translate to upper case.