The parameters are explained as follows:

,INFOTYPE=SUMMARY

,INFOTYPE=WORK

,INFOTYPE=INSTANCE

When REQUEST=SERVERINFO is specified, use this optional parameter to indicate the type of server information to be obtained and returned in the DATAAREA provided on the IXCRECV macro service. The contents and mapping of the data area depends on the the particular request. See mapping macro IXCYSRVR for details. The default is INFOTYPE=SUMMARY.

,INFOTYPE=SUMMARY

Obtain summary information that describes a server.

,INFOTYPE=WORK

Obtain information that describes work that is pending for processing by the server and currently being worked on by the server.

,INFOTYPE=INSTANCE

Obtain information about the instantiated server instance(s).

One or more values might be specified for the INFOTYPE parameter. If more than one value is specified, group the values within parentheses.

,LISTALL

,SERVER=server

,SERVERID=serverid

When REQUEST=SERVERINFO is specified, use this required input parameter to obtain information about servers or server ids. You must specify one of the following mutually exclusive keywords:

,LISTALL

A parameter keyword to request information about all servers defined to XCF on a system.

,SERVER=server

A parameter variable containing the name of the server name or server name pattern for which information is to be returned.

Server names and server name patterns are mapped by ixcysrvr_tName (macro IXCYSRVR). Server names and server name patterns consist of four 8 byte sections. Each 8 byte section must be left justified, padded on the right with EBCDIC blanks as needed. Each section can contain any alphanumeric (A-Z,a-z,0-9), national (@,#,$), or underscore (_) character. Any section but the first can be entirely blank. Any section can contain a pattern with wild card characters. A question mark ('?') within the pattern will match any one character and an asterisk ('*') within the pattern will match any sequence of zero or more characters. Server names are case sensitive.

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

,SERVERID=serverid

A parameter variable that contains the server ID of the specific server instance for which information is to be returned for.

Server IDs for server instances of a server are available in the srvrIir_ServerID field of a ixcysrvr_tSrvrInfoIR record for an IXCREQ SERVERINFO request that specified INFOTYPE=INSTANCE.

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

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

Use this required input parameter to specify the macro form.

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

Use MF=M with the list form of the macro to provide different options according to user-provided input. Use the list form to define a storage area, and use the modify form to set the appropriate options.

IBM® suggests that you use the modify and execute forms of IXCREQ in the following order:

• Use IXCREQ ...MF=(M,list-addr,COMPLETE) specifying appropriate parameters, including all required ones.
• Use IXCREQ ...MF=(M,list-addr,NOCHECK), specifying the parameters that you want to change.
• Use IXCREQ ...MF=(E,list-addr,NOCHECK), to execute the macro.

,list addr

The name of a storage area to contain the parameters. For MF=E and MF=M, this can be an RS-type name 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.

,NOCHECK

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

Use this optional input parameter to specify 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

,REQUEST=SERVERINFO

Use this required parameter to indicate which request is to be formatted for one or more of the XCF servers to process.

REQUEST=SERVERINFO

Obtain server definition, server message delivery, work item and server instance information.

,RETCODE=retcode

Use this 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 name of a fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or (R15).

,RSNCODE=rsncode

Use this 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 name of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00), REG0), (REG00), or (R0).