Parameters

The parameters are explained as follows:

name

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

,ANSAREA=ansarea

A required output parameter, variable specifying an area to contain the data returned by the query service. If the length of the output area is insufficient, no data is returned.

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

,ANSLEN=anslen

A required input parameter, which contains the length of the answer area.

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

,ASID=asid

When INFO=ONE is specified, a required input parameter, which contains the ASID of the address space to be queried.

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

,ENCLAVES=NONE

,ENCLAVES=ALL

,ENCLAVES=ONE

An optional parameter, which indicates whether enclave information is requested. The default is ENCLAVES=NONE.

,ENCLAVES=NONE

indicates that no enclave information is requested.

,ENCLAVES=ALL

indicates that information for all enclaves should be returned.

,ENCLAVES=ONE

indicates that enclave information is requested for a particular enclave.

,ETOKEN=etoken

When ENCLAVES=ONE is specified, a required input parameter, which contains the enclave token of the enclave to be queried.

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

INFO=ALL

INFO=ONE

A required parameter, which indicates what information the query service is to return

INFO=ALL

indicates that information for all address spaces should be returned.

INFO=ONE

indicates that address space information is requested for a particular asid.

,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=0

,PLISTVER=1

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, if you use only the following parameters:

  ANSAREA	ASID	INFO
  ANSLEN	ENCLAVES	QUERYLEN

• 1, if you use the following parameter and those of version 0:

  ETOKEN

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0 or 1

,QUERYLEN=querylen

A required output parameter, which contains the length of the storage area required by the IWMRQRY service. The length of the area may change between invocations.

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