Parameters

The parameters are explained as follows:

name
An optional symbol, starting in column 1, that is the name on the HZSQUERY macro invocation. The name must conform to the rules for an ordinary assembler language symbol.
,ANSAREA=ansarea
A required output parameter which is to contain the returned information The area is mapped by macro HZSQUAA. The header area is mapped by DSECT HZSQUAAHDR.

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

,ANSAREA64=ansarea64
A required output parameter which is to contain the returned information The area is mapped by macro HZSQUAA. This area can be above 2G. The header area is mapped by DSECT HZSQUAAHDR64.

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

,ANSLEN=anslen
A required input parameter which contains the length of the provided answer area. The length must be at least the value specified by symbol HZSQUERY_MIN_ANSLEN in macro HZSQUAA.

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

,ANSLEN64=anslen64
A required input parameter which contains the length of the provided answer area. The length must be at least the value specified by symbol HZSQUERY_MIN_ANSLEN64 in macro HZSQUAA. It can exceed 2G.

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

,CATEGORY=category
,CATEGORY=ANY_CATEGORY
When REQUEST=CHECKINFO is specified, an optional input parameter that specifies an array of 1 to 16 contiguous 16 character entries each of which contains a category to be associated with the check. The categories are used as filters. Each category can include wildcard characters. Checks that belong to categories that match according to the rules of the CATRULE parameter and according to the other filtering parameters (OWNER, NAME, and EXITRTN) are processed. The number of categories is specified by the NUMCAT parameter. The default is ANY_CATEGORY.

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

,CATRULE=DEFAULT
,CATRULE=ONLY
,CATRULE=ANY
,CATRULE=EVERY
,CATRULE=EXCEPT
,CATRULE=VALUE
When CATEGORY=category and REQUEST=CHECKINFO are specified, a required parameter that indicates how to process the category filters.
,CATRULE=DEFAULT
indicates to apply the default (which is CATRULE=ONLY).
,CATRULE=ONLY
indicates to match only if all the categories match the categories to which the target check belongs, and if the target check belongs to exactly the number of categories specified by the NUMCAT parameter.
,CATRULE=ANY
indicates to match if any of the categories provided match any of the categories to which the target check belongs.
,CATRULE=EVERY
indicates to match if every one of the categories provided matches any of the categories to which the target check belongs.
,CATRULE=EXCEPT
indicates to match except when one of the categories provided matches any of the categories to which the target check belongs.
,CATRULE=VALUE
Indicates that the value specified by CATRULEVAL is to be used.
,CATRULEVAL=catruleval
When CATRULE=VALUE, CATEGORY=category and REQUEST=CHECKINFO are specified, a required input parameter that indicates the category rule to be applied. It must be one of the values defined by the xxx_CATRULE_yyy equates generated by HZSQUERY MF=(L,xxx).

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

,CHECKNAME=checkname
When REQUEST=CHECKINFO is specified, a required input parameter field that identifies the name of the check. If the first character is x'00', or the value is all blanks, information about all checks is returned. Wildcard processing is performed on the name, using the standard wildcard symbols of "*" and "?". The check pattern is delineated by the last non-blank found within the input. Example: A check pattern of "*" indicates to match all checks. Example: A check pattern of "A*" indicates to match all checks with names beginning with "A".

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

,CHECKNAME=checkname
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the name of the check. No Wildcard processing is performed on the name.

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

,CHECKNAME=checkname
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the name of the check. No Wildcard processing is performed on the name.

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

,CHECKOWNER=checkowner
When REQUEST=CHECKINFO is specified, a required input parameter field that identifies the owner of the check. If the first character is x'00', or the value is all blanks, information about checks with all owners is returned. Wildcard processing is performed on the name, using the standard wildcard symbols of "*" and "?". The owner pattern is delineated by the last non-blank found within the input. Example: an owner pattern of "*" indicates to match all owners. Example: an owner pattern of "A*" indicates to match all owners with names beginning with "A".

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

,CHECKOWNER=checkowner
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the owner of the check. No Wildcard processing is performed on the name.

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

,CHECKOWNER=checkowner
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the owner of the check. No Wildcard processing is performed on the name.

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

,CHECKTYPE=ALL
,CHECKTYPE=NOTDELETED
,CHECKTYPE=DELETED
When REQUEST=CHECKINFO is specified, an optional parameter, of the checks for which information is to be returned. The default is CHECKTYPE=ALL.
,CHECKTYPE=ALL
that indicates that no restrictions are to be made. Return information about checks of any type. The type of the returned check is defined by field Hzsquaac_Type / Hzsquaac1_Type in macro HZSQUAA.
,CHECKTYPE=NOTDELETED
that indicates to return information only about checks that are not deleted and are not delete-pending
,CHECKTYPE=DELETED
that indicates to return information only about checks that are deleted or are delete-pending.
,EXCEPTION=NOTAPPLICABLE
,EXCEPTION=BYDATE
,EXCEPTION=BYSYNCVAL
,EXCEPTION=ALL
When CHECKTYPE=ALL and REQUEST=CHECKINFO are specified, an optional parameter that indicates what policy exception processing to do The default is EXCEPTION=NOTAPPLICABLE.
,EXCEPTION=NOTAPPLICABLE
that indicates that policy exception processing is not applicable to this request
,EXCEPTION=BYDATE
that indicates to find only checks that have policy DATE exceptions, i.e. a policy statement that matches this check was not applied because its DATE was older than the check's DATE.
,EXCEPTION=BYSYNCVAL
that indicates to find only checks that have policy SYNCVAL exceptions, i.e. a policy statement that matches this check was not applied because its SYNCVAL or (E)INTERVAL settings conflicted with the check's values.
,EXCEPTION=ALL
that indicates to find only checks that had any kind of policy exception.
,EXCEPTION=NOTAPPLICABLE
,EXCEPTION=BYDATE
,EXCEPTION=BYSYNCVAL
,EXCEPTION=ALL
When CHECKTYPE=NOTDELETED and REQUEST=CHECKINFO are specified, an optional parameter that indicates what policy exception processing to do The default is EXCEPTION=NOTAPPLICABLE.
,EXCEPTION=NOTAPPLICABLE
that indicates that policy exception processing is not applicable to this request
,EXCEPTION=BYDATE
that indicates to find only checks that have policy DATE exceptions, i.e. a policy statement that matches this check was not applied because its DATE was older than the check's DATE.
,EXCEPTION=BYSYNCVAL
that indicates to find only checks that have policy SYNCVAL exceptions, i.e. a policy statement that matches this check was not applied because its SYNCVAL or (E)INTERVAL settings conflicted with the check's values.
,EXCEPTION=ALL
that indicates to find only checks that had any kind of policy exception.
,EXITRTN=exitrtn
,EXITRTN=ANY_EXITRTN
When REQUEST=CHECKINFO is specified, an optional input parameter that identifies the name of the exit routine associated with the check, to be used as a filter. EXITRTN can include wildcard characters. All checks with names that match the specified name and that match the other filtering parameters (OWNER, NAME, CATEGORY) are processed. The default is ANY_EXITRTN.

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

,GLOBALCHECK=DONOTFIND
,GLOBALCHECK=FINDSYSTEM
When REQUEST=CHECKINFO is specified, an optional parameter that indicates what to process for global checks. It is relevant only to calls that specify something other than OUTPUTSTYLE=SHORT. The default is GLOBALCHECK=DONOTFIND.
,GLOBALCHECK=DONOTFIND
that indicates not to find the system on which the global check is being run.
,GLOBALCHECK=FINDSYSTEM
that indicates to find the system on which the global check is to be run. Field PQE_GlobalCheck_SYSNAME contains the name of that system, or zeroes if no system is currently tagged to run that check.
,INSTANCE=CURRENT
,INSTANCE=MUSTMATCH
,INSTANCE=LOGSTREAM
When REQUEST=MSGBUFF is specified, a required parameter that indicates how to compare the instance of the check designated by the MSGTOKEN parameter to the instance of the check.
,INSTANCE=CURRENT
indicates to return the message buffer(s) for the current instance of the check, and set bit HzsquaaH_MsgBuffWrongInstance / HzsquaaH64_MsgBuffWrongInstance when the instance of the check designated by the MSGTOKEN parameter is not the current instance.
,INSTANCE=MUSTMATCH
indicates to return data only if the message buffer(s) for the instance of the check designated by the MSGTOKEN parameter are available. They might not be available if the instance is not the current instance.
,INSTANCE=LOGSTREAM
Indicates that the message data to be returned is to be found within the logstream. You would use this when you want the information from a previous iteration of a check. Note that if you are basing this request on the "current" information returned from a previous call that specified INSTANCE=CURRENT or INSTANCE=MUSTMATCH, it is possible that the logstream data that you receive back will be the same information that was returned for that previous call. This could happen if the message buffer has already been written to the logstream and no new iteration of the check has yet begun. Compare the Hcklog_CheckHasRunCount fields of the two calls and if they are identical, this has happened (and you would just call "again" using the data returned on this call).

Also of note is that if the first Hcklog area does not have a value of 1 in field HckLog_BufNum, it means that this query was done while the check's data was being written to the logstream. The data retrieved is a subset of the data that INSTANCE=CURRENT or INSTANCE=MUSTMATCH would have returned. You can use the information returned within the QUAAC1HDR parameter to reference the check instance prior to this one, on a subsequent HZSQUERY call. Bit HZSQUAAH_MsgbuffIncomplete / HZSQUAAH64_MsgbuffIncomplete will als be on if this has occurred.

The system uses the IXGCONN REQUEST=CONNECT service to access the logstream. The caller of HZSQUERY must satisfy the System Authorization Facility (SAF) checks that are performed by that service. Refer to the documentation of IXGCONN for additional information.

Start of change,KEEP=NOEnd of change
Start of change,KEEP=YESEnd of change
Start of change,KEEP=CLOSEEnd of change
Start of changeWhen INSTANCE=LOGSTREAM is specified, an optional keyword input that indicates whether to keep the logstream connection and browse session upon return. The default is KEEP=NO.
,KEEP=NO
 indicates to close the browse session and logstream connection prior to return.
,KEEP=YES
indicates to keep the logstream connected and the browse session open upon successful return (return code less than 8) unless there is known to be no previous record (as indicated by field HzsquaaC1LogstreamBlockID in Hzsquaa1hdr being zero). If there is no previous record, then the browse session is closed and the logstream disconnected prior to return. This option is available only if the caller is supervisor state or PSW key 0-7. If the caller is problem state key 8-15, this option is treated as if KEEP=NO were specified. When KEEP=YES is specified, be sure that no previous HZSQUERY for this browse session resulted in closing the browse session (whether due to KEEP=CLOSE or to unsuccessful completion).
,KEEP=CLOSE
indicates to close the browse session and disconnect the logstream. No data is returned. This option is available only if the caller is supervisor state or PSW key 0-7. If the caller is problem state key 8-15, this option is treated as if KEEP=NO were specified. If you have used KEEP=YES you must use KEEP=CLOSE unless a subsequent call results in a return code greater than or equal to 8 or a logstream block ID of 0. This includes cases where your application's recovery gets control without having had a chance in its mainline to use KEEP=CLOSE. If the job step or address space terminates, it is not necessary to have a KEEP=CLOSE invocation. When KEEP=CLOSE is specified, be sure that no previous HZSQUERY for this browse session resulted in closing the browse session (whether due to KEEP=CLOSE or to unsuccessful completion).
End of change
,LOCALE=ANY
,LOCALE=HZSPROC
,LOCALE=REMOTE
When REQUEST=CHECKINFO is specified, an optional parameter, which identifies the locale of the check. The default is LOCALE=ANY.
,LOCALE=ANY
indicates that the check can be of any locale (hzsproc, remote or REXX)
,LOCALE=HZSPROC
indicates that the check must be of locale HZSPROC (i.e., runs in the IBM® Health Checker for z/OS® address space start by hzsproc).
,LOCALE=REMOTE
indicates that the check is remote (i.e., does not run in the IBM Health Checker for z/OS address space start).
,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.
,MSGTOKEN=msgtoken
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, a required input parameter, field that is the message token returned by a previous HZSQUERY request.

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

,MSGTOKEN=msgtoken
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, a required input parameter, field that is the message token returned by a previous HZSQUERY request.

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

,NAME=name
When REQUEST=CHECKINFO is specified, a required input parameter field that identifies the name of the check. If the first character is x'00', or the value is all blanks, information about all checks is returned. Wildcard processing is performed on the name, using the standard wildcard symbols of "*" and "?". The check pattern is delineated by the last non-blank found within the input. Example: A check pattern of "*" indicates to match all checks. Example: A check pattern of "A*" indicates to match all checks with names beginning with "A".

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

,NAME=name
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the name of the check. No Wildcard processing is performed on the name.

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

,NAME=name
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the name of the check. No Wildcard processing is performed on the name.

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

,NUMCAT=numcat
When CATEGORY=category and REQUEST=CHECKINFO are specified, a required input parameter that indicates how many categories are contained in the array specified by the CATEGORY parameter.

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

,OUTPUTSTYLE=FULL
,OUTPUTSTYLE=NO_CHKWORK
,OUTPUTSTYLE=SHORT
,OUTPUTSTYLE=VALUE
When REQUEST=CHECKINFO is specified, an optional parameter that indicates the style of output The default is OUTPUTSTYLE=FULL.
,OUTPUTSTYLE=FULL
that indicates to return the full amount of data, each HzsquaaCData / HzsquaaC1Data entry mapped by macro HZSPQE or HZSDPQE.
,OUTPUTSTYLE=NO_CHKWORK
that indicates to return the full amount of data except for the x'800' bytes of the PQE_CHKWORK area. Each HzsquaaCData / HzsquaaC1Data entry mapped by macro HZSPQE (up to the PQE_CHKWORK field) or HZSDPQE.
,OUTPUTSTYLE=SHORT
that indicates to return the "short form", each HzsquaaCData /HzsquaaC1Data entry mapped by DSECT HZSQUAACS in macro HZSQUAA.
,OUTPUTSTYLE=VALUE
indicates that the value specified by OUTPUTSTYLEV is to be used.
,OUTPUTSTYLEV=outputstylev
When OUTPUTSTYLE=VALUE and REQUEST=CHECKINFO are specified, a required input parameter that indicates the output style to be used. It must be one of the values defined by the xxx_OUTPUTSTYLE_yyy equates generated by HZSQUERY MF=(L,xxx).

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

,OWNER=owner
When REQUEST=CHECKINFO is specified, a required input parameter field that identifies the owner of the check. If the first character is x'00', or the value is all blanks, information about checks with all owners is returned. Wildcard processing is performed on the name, using the standard wildcard symbols of "*" and "?". The owner pattern is delineated by the last non-blank found within the input. Example: an owner pattern of "*" indicates to match all owners. Example: an owner pattern of "A*" indicates to match all owners with names beginning with "A".

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

,OWNER=owner
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the owner of the check. No Wildcard processing is performed on the name.

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

,OWNER=owner
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, a required input parameter field that identifies the owner of the check. No Wildcard processing is performed on the name.

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

,PLISTVER=IMPLIED_VERSION
,PLISTVER=MAX
,PLISTVER=0
,PLISTVER=1
,PLISTVER=2
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, which supports all parameters except those specifically referenced in higher versions.
  • 1, which supports both the following parameters and those from version 0:
    • POLICYNAME
  • 2, which supports both the following parameters and those from version 0 and 1:
    • ANSAREA64
    • ANSLEN64
    • QUAAC1HDR
To code: Specify one of the following:
  • IMPLIED_VERSION
  • MAX
  • A decimal value of 0, 1, or 2
,QUAACVER=0
,QUAACVER=1
When REQUEST=CHECKINFO is specified, an optional parameter that indicates the format of information to be returned for REQUEST=CHECKINFO, as mapped by DSECTs within HZSQUAA. Quaacver=1 returns more information than Quaacver=0. The default is QUAACVER=0.
,QUAACVER=0
The header information for each CHECKINFO entry is mapped by DSECT HZSQUAAC.
,QUAACVER=1
The header information for each CHECKINFO entry is mapped by DSECT HZSQUAAC1. Note that when you specify, or conditionally plan to specify on a subsequent invocation, INSTANCE=LOGSTREAM, you must specify QUAACVER=1 in order to get back the proper data for the INSTANCE=LOGSTREAM specification.
,QUAAC1HDR=quaac1hdr
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, an optional output parameter, area mapped by HZSQUAAC1 field HZSQUAAC1HDR that is to returned. This area identifies the next older check iteration MSGBUFF should the caller wish to retrieve that information using HZSQUERY with INSTANCE=LOGSTREAM.
Start of changeIf the QUAAC1HDR area had been returned on an invocation that specified KEEP=YES, be sure not to use this area while also specifying KEEP=YES:
  • if a subsequent INSTANCE=LOGSTREAM invocation resulted in closing that browse session (whether due to KEEP=CLOSE or to unsuccessful completion)
  • if there was a change of logstream name in a subsequent INSTANCE=LOGSTREAM invocation, in which case the system would have closed that browse session, so that this new request would get return code X'0C' with reason code HzsqueryRsn_LogstreamError. To avoid this, check the logstream name returned on each subsequent iteration and if it changes, avoid using this QUAAC1HDR area with KEEP=YES.
It is OK to use such a QUAAC1HDR area if you specify KEEP=NO.End of change

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

,QUAAC1HDR=quaac1hdr
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, an optional output parameter, area mapped by HZSQUAAC1 field HZSQUAAC1HDR that is to returned. This area identifies the next older check iteration MSGBUFF should the caller wish to retrieve that information using HZSQUERY with INSTANCE=LOGSTREAM.

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

,QUAAC1HDR=quaac1hdr
When INSTANCE=LOGSTREAM and REQUEST=MSGBUFF are specified, a required input/output parameter, area mapped by HZSQUAAC1 field HZSQUAAC1HDR that was returned in the answer area of a previous HZSQUERY request that specified either REQUEST=CHECKINFO with QUAACVER=1 or REQUEST=MSGBUFF with the QUAAC1HDR parameter. If that previous HZSQUERY was REQUEST=CHECKINFO, the HZSQUAAC1HDR area is part of the HZSQUAAC1 area of the answer area. If that previous HZSQUERY was REQUEST=MSGBUFF, the HZSQUAAC1HDR area was returned via the QUAAC1HDR parameter. On input, this area identifies the instance of the MSGBUFF for which data is to be returned. On output, this area identifies the next older check iteration MSGBUFF should the caller wish to retrieve that information.

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

REQUEST=GENINFO
REQUEST=CHECKINFO
REQUEST=MSGBUFF
A required parameter, which identifies the type of request.
REQUEST=GENINFO
Get general information about IBM Health Checker for z/OS. This includes the procedure used to start it, and the started task identifier assigned to it. The returned information consists of
  • a header area (mapped by DSECT HZSQUAAHDR or DSECT HZSQUAAHDR64 in macro HZSQUAA, depending on whether you use the ANSLEN or ANSLEN64 parameter), which contains the procedure used to start IBM Health Checker for z/OS, the started task identifier, and the logstream name, as well as a value of one in field HzsquaahNumQuaaG / Hzsquaah64NumQuaaG indicating that there is one entry provided, with the address of that entry being in field HzsquaahQuaaGAddr / Hzsquaah64QuaaGAddr.
  • the entry (mapped by DSECT HZSQUAAG in macro HZSQUAA)
REQUEST=CHECKINFO
Get information about the specified check. The information consists of
  • a header area (mapped by DSECT HZSQUAAHDR or DSECT HZSQUAAHDR64 in macro HZSQUAA, depending on whether you use the ANSLEN or ANSLEN64 parameter), which contains the number of entries that follows (HzsquaahNumQuaaC / Hzsquaah64NumQuaaC) and the address of the first entry (HzsquaahQuaaCAddr / Hzsquaah64QuaaCAddr).
  • entries (mapped by DSECT HZSQUAAC / HZSQUAAC1 in macro HZSQUAA) each of which has a field that indicates the length of that entry (HzsquaaCLen / HzsquaaC1Len). The length field should be added to the address of an entry to get the address of the next entry.
REQUEST=MSGBUFF
Get information about the message buffer(s) specified by the input MSGTOKEN. That MSGTOKEN would have been returned on a previous HZSQUERY request in field HzsquaaCMsgToken. The information consists of
  • a header area (mapped by DSECT HZSQUAAHDR or DSECT HZSQUAAHDR64 in macro HZSQUAA, depending on whether you use the ANSLEN or ANSLEN64 parameter), which contains the number of entries that follows (HzsquaahNumHCKL / Hzsquaah64NumHCKL) and the address of the first entry (HzsquaahHcklAddr / Hzsquah64HcklAddr).
  • entries (mapped by DSECT HZSLOG in macro HZSZHCKL) each of which has a field that indicates the length of that entry (Hcklog_BufLen). The length field should be added to the address of an entry to get the address of the next entry.
,RESULT=ANY
,RESULT=EXCEPTIONS
When CHECKTYPE=ALL and REQUEST=CHECKINFO are specified, an optional parameter that indicates what result processing to do The default is RESULT=ANY.
,RESULT=ANY
that indicates that any check result is applicable to this request
,RESULT=EXCEPTIONS
that indicates to find only checks that detected exception(s). Note that DELETED checks are not considered to have detected exception(s).
,RESULT=ANY
,RESULT=EXCEPTIONS
When CHECKTYPE=NOTDELETED and REQUEST=CHECKINFO are specified, an optional parameter that indicates what result processing to do The default is RESULT=ANY.
,RESULT=ANY
that indicates that any check result is applicable to this request
,RESULT=EXCEPTIONS
that indicates to find only checks that detected exception(s).
,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=ANY
,REXX=NO
,REXX=YES
When LOCALE=REMOTE and REQUEST=CHECKINFO are specified, an optional parameter, which indicates if this is a REXX check. The default is REXX=ANY.
,REXX=ANY
indicates that the check can either be a REXX check or not.
,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
When SECCHECKONLY=NO and REQUEST=CHECKINFO are specified, 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.
,SECCHECK=UNAUTH
,SECCHECK=ALL
When SECCHECKONLY=NO, INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, 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.
,SECCHECK=UNAUTH
,SECCHECK=ALL
When SECCHECKONLY=NO, INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, 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.
,SECCHECKONLY=NO
,SECCHECKONLY=YES
When REQUEST=CHECKINFO is specified, an optional parameter that indicates whether to do full processing or only security checks. The default is SECCHECKONLY=NO.
,SECCHECKONLY=NO
that indicates to do full processing.
,SECCHECKONLY=YES
that indicates to do only the security check to see if the requesting user has RACF authority to access the data. When this option is specified, the security check is done regardless of the caller's key or state.
,SECCHECKONLY=NO
,SECCHECKONLY=YES
When INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, an optional parameter that indicates whether to do full processing or only security checks The default is SECCHECKONLY=NO.
,SECCHECKONLY=NO
that indicates to do full processing.
,SECCHECKONLY=YES
that indicates to do only the security check to see if the requesting user has RACF authority to access the data. When this option is specified, the security check is done regardless of the caller's key or state.
,SECCHECKONLY=NO
,SECCHECKONLY=YES
When INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, an optional parameter that indicates whether to do full processing or only security checks The default is SECCHECKONLY=NO.
,SECCHECKONLY=NO
that indicates to do full processing.
,SECCHECKONLY=YES
that indicates to do only the security check to see if the requesting user has RACF authority to access the data. When this option is specified, the security check is done regardless of the caller's key or state.
,SYSNAME=sysname
,SYSNAME=CURRENT
When SECCHECKONLY=YES and REQUEST=CHECKINFO are specified, an optional input parameter that specifies the system name to be used when doing the security check. Note that this specification is used only when the caller is supervisor state, system key, or APF-authorized. The default is CURRENT. which indicates to use the name of the system on which this request was issued.

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

,SYSNAME=sysname
,SYSNAME=CURRENT
When SECCHECKONLY=YES, INSTANCE=CURRENT and REQUEST=MSGBUFF are specified, an optional input parameter that specifies the system name to be used when doing the security check. Note that this specification is used only when the caller is supervisor state, system key, or APF-authorized. The default is CURRENT. which indicates to use the name of the system on which this request was issued.

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

,SYSNAME=sysname
,SYSNAME=CURRENT
When SECCHECKONLY=YES, INSTANCE=MUSTMATCH and REQUEST=MSGBUFF are specified, an optional input parameter that specifies the system name to be used when doing the security check. Note that this specification is used only when the caller is supervisor state, system key, or APF-authorized. The default is CURRENT. which indicates to use the name of the system on which this request was issued.

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

,TEXTSTRING=YES
,TEXTSTRING=NO
An optional parameter that indicates whether to return the "text strings" mapped in HZSPQE for options that return data within the HZSPQE. It is relevant only to REQUEST=CHKINFO calls that specify something other than OUTPUTSTYLE=SHORT. The default is TEXTSTRING=YES.
,TEXTSTRING=YES
that indicates to return the HZSPQE "text strings".
,TEXTSTRING=NO
that indicates not to return the "text strings". If not using the HZSPQE output for displaying, specifying "NO" avoids setting some fields that you might not need.