Parameters

The parameters are explained as follows:

name

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

,ANSLEN=anslen

A required input parameter, which contains the length of the SYSINFO_BLOCK in bytes.

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

,EXTENDED_DATA=NO

,EXTENDED_DATA=YES

An optional input parameter, which describes whether the format of the output area named by SYSINFO_BLOCK includes the extended section or not (see IWMWSYSI). The default is EXTENDED_DATA=NO.

,EXTENDED_DATA=NO

indicates that the format of the output area named by SYSINFO_BLOCK includes only the standard information mapped by the SYSI, which consists of an array of entries described by SYSI_ENTRY.

,EXTENDED_DATA=YES

indicates that the format of the output area given by SYSINFO_BLOCK includes first the standard information mapped by the SYSI, which consists of an array of entries described by SYSI_ENTRY, followed immediately by the header for the extension section and another array of entries described by SYSI_EXT_Entry.

The EXTENDED_DATA parameter is only available to callers of the IWMWSYSQ service when invoked on a system running z/OS® R9 or higher.

,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=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; in this way, MAX ensures that the parameter list does not overwrite nearby storage.

• 2, if you use the currently available parameters.

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 2

,QUERYLEN=querylen

A required output parameter, variable which contains the output area size that must be provided by the caller to contain all of the active systems in the sysplex that are in goal mode (i.e. the amount of data returned by the IWMWSYSQ service).

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

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

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

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

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

SYSINFO_BLOCK=sysinfo_block

A required input parameter that is to contain the address of an output area to contain information provided by this service. The format of this area is mapped by IWMWSYSI and should only be considered valid upon return code zero from this service.

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