Parameters

The parameters are explained as follows:

name

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

,ANSAREA=ansarea

A required output parameter that contains the address of a storage area to hold the information returned by IWMRCOLL. The area is mapped by the IWMWRCAA mapping macro.

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

,ANSLEN=anslen

A required input parameter that contains the length of the storage area (answer area) you are providing on ANSAREA.

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

,ANSTOKN=anstoken,

A required input/output parameter that contains a token value. On your first call to IWMRCOLL, you specify ANSTOKEN as an output parameter. IWMRCOLL provides a token value that is required for subsequent calls to IWMRCOLL.

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

ICS=NO

ICS=YES

An optional parameter that specifies whether IWMRCOLL should return ICS information, or workload activity information. The default is ICS=NO.

ICS=NO

Specifies that IWMRCOLL should return workload activity information.

ICS=YES

Specifies that IWMRCOLL should return ICS information. It is valid for systems prior to z/OS® R3 only.

,ICSAREA=icsarea

When ICS=YES is specified, a required output parameter that is valid for systems prior to z/OS R3 only.

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

,ICSLEN=icslen

When ICS=YES is specified, a required input parameter that is valid for systems prior to z/OS R3 only.

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

,ICSQLEN=icsqlen

When ICS=YES is specified, a required output parameter that is valid for systems prior to z/OS R3 only.

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

,MAXLEN=maxlen

A required output parameter that contains the maximum length of the storage area required by IWMRCOLL to contain all the performance data for transactions that might run while the ANSTOKN is valid.

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

,MF=S

,MF=(L,list addr)

,MF=(L,list addr, attr)

,MF=(L,list addr0D

,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 X'0F' to force the parameter list to a word boundary, or X'0D' to force the parameter list to a doubleword boundary. If you do not code ,attr, the system provides a value of X'0D'.

,COMPLETE

Specifies that the system is to check for required parameters and supply defaults for omitted optional parameters.

,MINLEN=minlen

A required output parameter that contains the minimum length of the storage area required by IWMRCOLL to contain all existing performance data.

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

,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

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

Specify PLISTVER=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

Specify PLISTVER=0 to use the currently available parameters.

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0

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