You can specify these parameters:

name

An optional symbol that starts in column 1. This is the name on the EDGXCI macro call. The name must conform to the rules for an ordinary assembler language symbol.

APIADDR=apiaddr

A required input parameter that contains the address of the DFSMSrmm API load module. The calling program is responsible for loading the DFSMSrmm API load module, saving, and then using the returned load address. Use the z/OS® LOAD service to obtain the DFSMSrmm API address.

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

EXPAND=NO

EXPAND=YES

When OUTPUT=FIELDS and OPERATION=BEGIN are specified, EXPAND is an optional parameter that specifies whether to expand the number of returned data fields to be the same as for the corresponding list type of subcommand. The default is EXPAND=YES.

EXPAND=NO

Specify to not expand the number of data fields for the subcommand.

EXPAND=YES

Specify to expand the number of data fields to be the same as the corresponding list type of subcommand.

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)

MF=(E,list addr,NOCHECK)

MF=(M,list addr)

MF=(M,list addr,COMPLETE)

MF=(M,list addr,NOCHECK)

An optional input parameter that specifies the macro form.

Use MF=S to specify the standard form of the macro. This 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 macro list form with the macro execute form 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 can 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.

Use MF=M together with the list form and execute form of the macro for service routines that need to provide different options according to user-provided input. Use the list form to define a storage area. Use the modify form to set the appropriate options. Then use the execute form to call the service.

Recommendation: Use the modify and execute forms of EDGXCI in this order:

1. Use EDGXCI ...MF=(M,list-addr,COMPLETE) and specify all the required parameters and any appropriate optional parameters.
2. Use EDGXCI ...MF=(M,list-addr,NOCHECK) and specify the parameters that you want to change.
3. Use EDGXCI ...MF=(E,list-addr,NOCHECK) to execute the macro.

,list addr

The name of a storage area to contain the parameters. For MF=S, MF=E, and MF=M, 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 ofX'0F'to force the parameter list to a word boundary orX'0D'to force the parameter list to a doubleword boundary. If you do not code attr, the system provides a value ofX'0D'.

COMPLETE

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

NOCHECK

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

MULTI=NO

MULTI=YES

When OUTPUT=FIELDS and OPERATION=BEGIN are specified, MULTI is an optional parameter that specifies whether a single resource group is to be returned in the buffer, or whether as many resources as fit in the buffer are to be returned. The default is MULTI=NO

MULTI=NO

Specifies that only a single entry can be handled by the API caller.

MULTI=YES

Specifies that multiple entries can be handled by the API caller.

OPERATION=BEGIN

OPERATION=CONTINUE

OPERATION=RELEASE

OPERATION=ENDALL

An optional parameter that describes the processing of the current subcommand. The default is OPERATION=BEGIN.

OPERATION=BEGIN

Specify BEGIN to start a new subcommand.

OPERATION=CONTINUE

Specify CONTINUE to continue the current subcommand.

OPERATION=RELEASE

Specify when you want the token and all its associated resources to be released.

OPERATION=ENDALL

Specify when you want to end all operations by releasing all tokens and all resources.

OUTBUFADDR=outbufaddr

When OPERATION=BEGIN is specified, OUTBUFADDR=outbufaddr is a required input parameter that contains the address of your output buffer, which is used for both data and messages. It must be at least 4096 bytes in length. The first four bytes of the buffer must contain the length of the buffer, including the four bytes of the length.

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

OUTBUFADDR=outbufaddr

When OPERATION=CONTINUE is specified, OUTBUFADDR=outbufaddr is a required input parameter that contains the address of your output buffer, which is used for both data and messages. It must be at least 4096 bytes in length. The first four bytes of the buffer must contain the length of the buffer, including the four bytes of the length.

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

OUTPUT=FIELDS

OUTPUT=LINES

When OPERATION=BEGIN is specified, OUTPUT is an optional parameter that specifies the format of the returned data. The default is OUTPUT=FIELDS.

OUTPUT=FIELDS

Specify when you want data returned in field format.

OUTPUT=LINES

Specify when you want data returned in line format. Search output is always returned in standard form when OUTPUT=LINES is specified.

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. Specify PLISTVER on all macro forms used for a request and with the same value on all of the macro forms. The PLISTVER 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, which allows you to change to the largest size currently possible. This size might grow from release to release and affect the amount of storage that your application program needs.

  Recommendation: If you can tolerate the size change, always specify PLISTVER=MAX on the list form of the macro. Specifying MAX ensures that the list-form parameter list is large 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 these:

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

SUBCMDADDR=subcmdaddr

When OPERATION=BEGIN is specified, SUBCMDADDR=subcmdaddr is a required input parameter that contains the address of the input subcommand. The subcommand consists of a halfword field followed by the subcommand text. The halfword field must contain the length of the subcommand, including both the halfword field and the subcommand text. The maximum value is 32 761.

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

TOKEN=token

When OPERATION=BEGIN is specified, TOKEN=token is a required input parameter of a 4-byte area. The DFSMSrmm API creates a token and obtains resources for it, or the DFSMSrmm API reuses the token and the resources.

TOKEN is required even when MF=(E,label,NOCHECK) is specified, unless OPERATION=ENDALL is also specified.

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

TOKEN=token

When OPERATION=CONTINUE is specified, TOKEN=token is a required input parameter of a 4-byte area containing the token used to begin the subcommand. The DFSMSrmm API uses the resources for the token to continue the subcommand.

TOKEN is required even when MF=(E,label,NOCHECK) is specified, unless OPERATION=ENDALL is also specified.

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

TOKEN=token

When OPERATION=RELEASE is specified, TOKEN=token is a required input parameter of a 4-byte area containing a token. The DFSMSrmm API releases the resources for the token, releases the token, and clears the 4-byte area.

TOKEN is required even when MF=(E,label,NOCHECK) is specified, unless OPERATION=ENDALL is also specified.

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