Parameters

The parameters are explained as follows:

name

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

,ABNORMAL_COND=abnormal_cond

An optional output parameter, which contains the current information about abnormal conditions which were either recorded in the input monitoring environment or which were propagated to it via IWMMXFER Function(Return). Multiple conditions may exist.

The mask, Iwmmabnl_Scope_LocalMVS, may be used to determine whether an abnormality which only affects work on the current MVS™ image was recorded.

The mask, Iwmmabnl_Scope_Sysplex, may be used to determine whether an abnormality which affects work on all MVS images in the sysplex was recorded.

To determine whether a condition was recorded, merely AND the field supplied for ABNORMAL_COND with the relevant mask. The result will be nonzero when the condition is true, zero when the condition is false.

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

,ARRIVALTIME=arrivaltime

An optional output parameter, which contains the work arrival time in STCK format.

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

,ASID=asid

An optional output parameter,which contains the address space ID. When the monitoring environment is not associated with an address space, the output will be a halfword of binary zeros.

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

,ENCLAVE_TOKEN=enclave_token

An optional output parameter, which contains the enclave token. When the monitoring environment is not associated with an enclave, the output will be a doubleword of binary zeros.

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

,EWLM_CHCORR=ewlm_chcorr

An optional output parameter, which contains the cross-platform Enterprise Workload Management (EWLM) correlator of the work request associated with the monitoring environment.

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

,EWLM_PACTKN=ewlm_pactkn

An optional output parameter, which contains the cross-platform Enterprise Workload Management (EWLM) parent correlator token of the work request associated with the monitoring environment.

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

,EWLM_S_CURCORR=ewlm_s_curcorr

An optional output parameter, which contains the current correlator of the work unit started by IWMMSTRT. Normally this correlator is different from the child correlator of the work request created by IWM4MINI.

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

MONTKN=montkn

A required input parameter, which contains the delay monitoring token

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

,OWNER_DATA=owner_data

An optional output parameter, which is to receive the data established by the user/owner of the monitoring environment. The format is undefined to MVS. When the monitoring environment is not associated with an OWNER_TOKEN value, the output will be a word of binary zeros.

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

,OWNER_TOKEN=owner_token

An optional output parameter, which is to receive the token established by the user/owner of the monitoring environment. The format is undefined to MVS. When the monitoring environment is not associated with an OWNER_TOKEN value, the output will be a word of binary zeros.

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

,PLISTVER=3

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.

• 0, which supports all parameters except those specifically referenced in higher versions.
• 1, which supports the following parameter and those from version 0:
  TTRACETOKEN
  
• 2, which supports the following parameters and those from version 0 and 1:
  ASID
  ENCLAVE_TOKEN
  
• 3, which supports the following parameters and those from version 0, 1, and 2:
  EWLM_CHCORR
  EWLM_PACTKN
  
• 4, which supports the following parameter and those from version 0, 1, 2, and 3:
  EWLM_S_CURCORR
  

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, 1, 2, 3, or 4

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

,SERVCLS=servcls

An optional output parameter, which contains the service class token. When the monitoring environment is not associated with a service class token, the output will be a word of binary zeros.

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

,TRXNAME=trxname

An optional output parameter, which contains the transaction name. The field will be all blanks when NO_TRXNAME was specified on IWM4MINI.

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

,TTRACETOKEN=ttracetoken

An optional output parameter, which contains the transaction trace token associated with the work request. The field will be all zero when NO_TTRACETOKEN was specified on IWM4MINI.

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

,USERID=userid

An optional output parameter, which contains the local user ID associated with the work request. The field will be all blanks when NO_USERID was specified on IWM4MINI.

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