Parameters

The parameters are explained as follows:

name

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

,ECB=ecb

,ECB=NO_ECB

When MODE=POST is specified, an optional input parameter, to specify the ECB which should be posted if WLM wants to inform the caller that the number of server instances have changed. The caller re-invokes IWMSINF after the ECB was posted by WLM to obtain number of server instances to start. The default is NO_ECB, which indicates that no ECB has been specified by the caller.

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

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

MODE=SUSPEND

MODE=POST

MODE=INFORM

MODE=ECBCANCEL

A required parameter that indicates how the caller uses the service

MODE=SUSPEND

indicates that the caller wants to get suspended by WLM to listen for additional server instances to start. WLM will resume the caller if the number of server instances should be increased.

MODE=POST

indicates that the caller wants to get posted if additional server instances should be started. If the caller gets posted it must re-invoke IWMSINF to obtain the value.

The caller is not suspended by WLM and WLM will also return the number of additional server instances on this call.

MODE=INFORM

indicates that the caller wants to obtain the number of server instances without being suspended by WLM. This form is useful during initialization after IWM4CON if the caller wants to use the POST form but is not able to provide an ECB yet. It is expected that the caller will provide an ECB on the next invocation of the service.

MODE=ECBCANCEL

indicates that a caller who passed an ECB to WLM wants to cancel the ECB address to avoid being posted in the future by WLM.

This form is usefull during termination or recovery of server address spaces if a previous ECB address is no longer valid.

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

,SRVINST_TO_STRT=srvinst_to_strt

When MODE=SUSPEND is specified, a required output parameter that returns the number of server instances to start by the caller

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

,SRVINST_TO_STRT=srvinst_to_strt

When MODE=POST is specified, a required output parameter that returns the number of server instances to start by the caller

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

,SRVINST_TO_STRT=srvinst_to_strt

When MODE=INFORM is specified, a required output parameter that returns the number of server instances to start by the caller

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