Parameters

The parameters are explained as follows:

name

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

,COMPCODE=YES

,COMPCODE=NO

An optional parameter, which indicates whether completion status for this service is needed. The default is COMPCODE=YES.

,COMPCODE=YES

indicates that completion status is needed.

,COMPCODE=NO

indicates that completion status is not needed. Registers 0, 15 cannot be used as reason code and return code registers upon completion of the macro expansion. For this reason neither RETCODE NOR RSNCODE may be specified when COMPCODE(NO) is specified.

,EWLM=NO

An optional parameter, which indicates if this work manager intents to participate in cross platform Enterprise Workload Management (eWLM). The default is EWLM=NO.

,EWLM=NO

The work manager interacts only with WLM and no interaction with eWLM takes place.

FUNCTION=CONTINUE

FUNCTION=RETURN

A required parameter, which indicates where there may be one or more other monitoring environments which represent current information about the work request. This is meant to cover further continuations of the work request, and does not deal with any parent environment that may exist.

FUNCTION=CONTINUE

indicates that the current environment is creating only a single continuation elsewhere.

FUNCTION=RETURN

indicates that any continuations of the work request have completed. These continuations may have been established through use of Transfer or Switch.

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

,MONTKN=montkn

A required input parameter which contains the delay monitoring token for the current environment.

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

,MONTKN64=montkn64

A required input parameter which contains the long delay monitoring token for the current environment.

To code: Specify the RS-type address, or address in register (2)-(12), of a 64 bit 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, 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

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

,RUNTIME_VER=SHORT_FORM

,RUNTIME_VER=MINIMAL

When FUNCTION=CONTINUE is specified, an optional parameter, which indicates what level of runtime verification will be performed. The default is RUNTIME_VER=SHORT_FORM.

,RUNTIME_VER=SHORT_FORM

indicates that checking should verify that a monitoring environment is established and passes a short form of verification prior to being used.

,RUNTIME_VER=MINIMAL

indicates that checking will only be done to verify that a monitoring environment may be established, assuming that it would be valid and useable if established.

,RUNTIME_VER=SHORT_FORM

,RUNTIME_VER=MINIMAL

When FUNCTION=RETURN is specified, an optional parameter, which indicates what level of runtime verification will be performed. The default is RUNTIME_VER=SHORT_FORM.

,RUNTIME_VER=SHORT_FORM

indicates that checking should verify that a monitoring environment is established and passes a short form of verification prior to being used.

,RUNTIME_VER=MINIMAL

indicates that checking will only be done to verify that a monitoring environment may be established, assuming that it would be valid and useable if established.

,WHERE=LOCALMVS

,WHERE=SYSPLEX

,WHERE=NETWORK

When FUNCTION=CONTINUE is specified, a required parameter, which indicates where there may be another monitoring environment

,WHERE=LOCALMVS

indicates that such an environment may exist on the current MVS.

,WHERE=SYSPLEX

indicates that such an environment may exist in the current syplex, but is not expected to be on the current MVS image.

,WHERE=NETWORK

indicates that such an environment may exist, but is not expected to be in the current sysplex.