Parameters

The parameters are explained as follows:

name

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

,DISPTYPE=TCB

,DISPTYPE=SRB

When FUNCTION=CREATE is specified, a required parameter, which describes the dispatchable units which participate in processing work requests associated with the monitoring environment represented by the monitoring token (MONTKN).

,DISPTYPE=TCB

indicates that work requests run in TCB mode under a TCB within the current home address space. Note that in cross-memory mode, this may be different from the current primary address space.

,DISPTYPE=SRB

indicates that work requests run in SRB mode within the current home address space.

FUNCTION=CREATE

FUNCTION=DELETE

A required parameter, which indicates whether the relationship is being established or inactivated.

FUNCTION=CREATE

indicates that the relationship is being established.

FUNCTION=DELETE

which indicates that the relationship is being inactivated.

Note that this produces an inline expansion rather than an out-of-line service, so that no parameter list is needed. Therefore, the MF keyword is not supported when this option is specified. Registers 0, 1, 14, and 15 are not preserved across the expansion.

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

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

,OWNER_DATA=owner_data

,OWNER_DATA=NO_OWNER_DATA

When FUNCTION=CREATE is specified, an optional input parameter, which contains data maintained by the user or owner of the monitoring environment. The format is undefined to MVS™. The default is NO_OWNER_DATA which indicates that no owner data is provided.

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

,OWNER_TOKEN=owner_token

,OWNER_TOKEN=NO_OWNER_TOKEN

When FUNCTION=CREATE is specified, an optional input parameter, which contains a token maintained by the user or owner of the monitoring environment. The format is undefined to MVS. The default is NO_OWNER_TOKEN which indicates that no owner token is provided on. this service.

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

,PARENTENV=NOSWITCH

,PARENTENV=SECONDARY

,PARENTENV=HOME

When PARENTP=YES and FUNCTION=CREATE are specified, a required parameter, which describes whether a space switch is needed to access the parent monitoring environment.

,PARENTENV=NOSWITCH

indicates that NO space switch is needed to access the parent monitoring environment. This would be appropriate if the parent monitoring environment was established (by IWM4MCRE) to be used by routines in a specific system key or if it was established to be used in a specific user key in the current primary.

,PARENTENV=SECONDARY

indicates that the parent monitoring environment was established in current secondary (for use by a specific user key).

,PARENTENV=HOME

indicates that the parent monitoring environment was established in current home (for use by a specific user key). Use of this option requires that the program must reside in the MVS common area.

,PARENTMONTKN=parentmontkn

When PARENTP=YES and FUNCTION=CREATE are specified, a required input parameter, which contains the delay monitoring token for the parent environment, for example, the monitoring environment which was established earlier and contains the characteristics to be inherited.

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

,PARENTP=YES

,PARENTP=FINDACTIVE

When FUNCTION=CREATE is specified, a required parameter, which describes whether the parent monitoring environment is known or not.

,PARENTP=YES

indicates that the parent monitoring environment is known.

Note, that this produces an inline expansion rather than an out-of-line service, so that no parameter list is needed. Therefore, the MF keyword is not supported when this option is specified. Registers 0, 1, 14, and 15 are not preserved across the expansion.

,PARENTP=FINDACTIVE

indicates that the parent monitoring environment is unknown, but requests that the input monitoring environment be related to the active monitoring environment owned by the current HOME address space and which is associated with the TCB specified by PARENTTCB and which has no further continuations to other monitoring environments. When no such monitoring environment exists, the input monitoring environment will be related to the current home address space.

,PARENTTCB=parenttcb

When PARENTP=FINDACTIVE and FUNCTION=CREATE are specified, a required input parameter, which defines the TCB owned by the current home address space associated with a monitoring environment via Initialize/Relate Disptype=TCB,TCB= . This TCB need not be the owner of the monitoring environment. Note that this name is not the pointer to the TCB, but the name of the data area containing the TCB. A typical invocation might replace xTCB with TCB.

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

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

,SAMEDU=YES

,SAMEDU=NO

When DISPTYPE=SRB and FUNCTION=CREATE are specified, a required parameter, which describes whether the dependent monitoring environment associated with MONTKN is running under the same dispatchable unit as the parent. In that case, it would behave as a "subroutine" and execute on the same processor (CP, a.k.a. CPU) as the parent environment.

,SAMEDU=YES

indicates that the work request runs as a subroutine of the parent.

YES may not be specified when PARENTP(FINDACTIVE) is coded.

,SAMEDU=NO

indicates that the work request runs in SRB mode and is independent of the parent dispatchable unit.

,TCB=tcb

When DISPTYPE=TCB and FUNCTION=CREATE are specified, a required input parameter, which defines the TCB within the current home address space which will serve the work request. Note that this name is not the pointer to the TCB, but the name of the data area containing the TCB. A typical invocation might replace xTCB with TCB.

Generally, the input TCB specified should be the TCB under which the work request (e.g. transaction program) runs and under which the delay information is recorded (in spite of the fact that task switches may occur).

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