Parameter Descriptions

The parameter descriptions for REQUEST=WRITE_LCONTROLS are listed in alphabetical order. Default values are underlined:

REQUEST=WRITE_LCONTROLS

Use this input parameter to change the list controls for a specified list.

,ANSAREA=NO_ANSAREA

,ANSAREA=ansarea

Use this output parameter to specify an answer area to contain information returned from a failed request. The format of the answer area is described by mapping macro IXLYLAA.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an area (with a size of ANSLEN) where the information about the request will be returned.

,ANSLEN=anslen

Use this input parameter to specify the size of the storage area specified by ANSAREA.

Check the prologue of the IXLYLAA mapping macro for the minimum required size of the answer area, or use the length field (LAA_LEN) in the LAA.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 2-byte field that contains the size, in bytes, of the answer area.

,AUTHCOMP=0

,AUTHCOMP=authcomp

Use this input parameter to specify a value to be compared to the list authority value of the list specified by LISTNUM.

The AUTHCOMP value must equal the list authority of the LISTNUM list, or the request terminates with no change to the structure.

Note: At the time the structure was allocated, the list authority value for each list in the structure was initialized to binary zeros.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field that contains the list comparison authority value, or take the default, AUTHCOMP=0.

,CONTOKEN=contoken

Use this input parameter to specify the connect token that was returned by the IXLCONN service. The connect token uniquely identifies your connection to the list structure, and must be specified on each IXLLIST invocation.

The connect token is available in the IXLCONN answer area mapped by IXLYCONA.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field that contains the connect token.

,LISTDESC=listdesc

Use this input parameter to specify a description to be associated with the list specified by LISTNUM. The description can be anything you want.

If LISTDESC is not specified, the list description of the LISTNUM list remains unchanged.

Note: At the time the structure was allocated, the list description for each list in the structure was initialized to binary zeros.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 32-byte field that contains the list description.

,LISTKEY=NO_LISTKEY

,LISTKEY=listket

Use this input parameter to specify the list key to be associated with the list. You may assign a list key value to list entries when they are created or moved.

If LISTKEY is not specified, the list key for the designated list remains unchanged.

Note: At the time the structure was allocated, the list key for each list in the structure was initialized to binary zeros. Use this parameter only with a coupling facility of CFLEVEL=1 or higher.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-character field that contains the list key to be associated with the list.

,LISTLIMIT=listlimit

Use this input parameter to specify the list limit—the maximum allowable number of entries or elements that can reside on the list specified by LISTNUM. Whether the limit is counted in terms of entries or elements depends on what you specified for the LISTCNTLTYPE parameter on the IXLCONN macro.

If LISTLIMIT is not specified, the list limit of the LISTNUM list remains unchanged.

Note: At the time the structure was allocated, the list limit for each list in the structure was initialized to the total number of entries or elements in the structure, depending on the value specified for LISTCNTLTYPE on the IXLCONN macro.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that contains the list limit.

,LISTNUM=listnum

Use this input parameter to specify the number of the list to which the list controls specified by this request will apply.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that contains the number of the list.

,MAXLISTKEY=NO_MAXLISTKEY

,MAXLISTKEY=maxlistkey

Use this input parameter to specify the maximum list key value to be associated with the list.

Note: At the time the structure was allocated, the maximum list key value for each list in the structure was initialized to binary zeros. Use this parameter only with a coupling facility of CFLEVEL=1 or higher.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-byte field that contains the maximum list key value.

,MF=S

,MF=(L,mfctrl)

,MF=(L,mfctrl,mfattr)

,MF=(L,mfctrl,0D)

,MF=(E,mfctrl)

,MF=(E,mfctrl,COMPLETE)

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.

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 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 stores the parameters into the storage area defined by the list form, and generates the macro invocation to transfer control to the service.

,mfctrl: Use this output parameter to specify a storage area to contain the parameters.
To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list.
,mfattr: Use this input parameter to specify the name of a 1- to 60-character string that can contain any value that is valid on an assembler DS pseudo-op. You can use this parameter to force boundary alignment of the parameter list. If you do not code mfattr, the system provides a value of 0D, which forces the parameter list to a doubleword boundary.
,COMPLETE: Use this input parameter to require that the system check for required parameters and supply defaults for omitted optional parameters.
Note: In the macro expansion you might see some defaults for optional parameters that are not documented here. The ones that are not documented do not have any effect on the macro. For example, if SMILE=var were an optional parameter and the default is SMILE=NO_SMILE then it would not be documented. However, if the default was SMILE=:-), then it would be documented because a value would be the default.

,MODE=SYNCSUSPEND

,MODE=SYNCECB

,MODE=SYNCEXIT

,MODE=SYNCTOKEN

,MODE=ASYNCECB

,MODE=ASYNCEXIT

,MODE=ASYNCTOKEN

,MODE=ASYNCNORESPONSE

Use this input parameter to specify:

Whether the request is to be performed synchronously or asynchronously
How you wish to be notified of request completion

MODE=SYNCSUSPEND: The request is suspended until it can complete synchronously. To use this option, your program must be enabled for I/O and external interrupts.
MODE=SYNCECB: The request processes synchronously if possible. If the request processes asynchronously, the ECB specified by REQECB is posted when the request completes.
MODE=SYNCEXIT: The request processes synchronously if possible. If the request processes asynchronously, your complete exit is given control when the request completes.
MODE=SYNCTOKEN: The request processes synchronously if possible. If the request processes asynchronously, an asynchronous request token is returned in the area specified by REQTOKEN on invocation of the request. Use the returned request token on the IXLFCOMP macro to determine whether your request has completed.
Note: ANSAREA is a required parameter when MODE=SYNCTOKEN is specified.
MODE=ASYNCECB: The request processes asynchronously. The ECB specified by REQECB is posted when the request completes.
MODE=ASYNCEXIT: The request processes asynchronously. Your complete exit is given control when the request completes.
MODE=ASYNCTOKEN: The request processes asynchronously. An asynchronous request token is returned in the area specified by REQTOKEN upon invocation of the request. Use the returned request token on the IXLFCOMP macro to determine whether your request has completed.
Note: ANSAREA is a required parameter when MODE=ASYNCTOKEN is specified.
MODE=ASYNCNORESPONSE: The request processes asynchronously. No notification of request completion is provided. The answer area (ANSAREA) fields will not contain valid information when this mode is specified.

Note: You cannot code MODE=ASYNCNORESPONSE with LOCKINDEX, BUFFER, or BUFLIST.

,NEWAUTH=newauth

Use this input parameter to specify a new list authority value to replace the existing list authority value of the list specified by LISTNUM.

If NEWAUTH is not specified, the list authority of the LISTNUM list will remain unchanged.

Note: At the time the structure was allocated, the list authority value for each list in the structure was initialized to binary zeros.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field that contains the new list authority value.

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=plistver

Use this input parameter to specify the version of the macro. See Understanding IXLLIST Version Support for a descriptions of the options available with PLISTVER.

,REQDATA=NO_REQDATA

,REQDATA=reqdata

Use this input parameter with MODE=SYNCEXIT or MODE=ASYNCEXIT to pass any data you choose to the complete exit. The exit will get control only if the request is processed asynchronously.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an 8-byte field that contains the data to be passed to the complete exit.

,REQECB=reqecb

Use this output parameter with either MODE=SYNCECB or MODE=ASYNCECB to specify the address of an ECB, which is to be posted when the request completes if the request was processed asynchronously.

Before coding REQECB, you must ensure that:

You initialize the ECB before you issue the request.
The ECB resides in either common storage or the home address space where IXLCONN was issued.
Any tasks that wait for the ECB to be posted reside in the home address space where IXLCONN was issued.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that contains the address of the ECB to be posted when the request completes. The ECB must be aligned on a fullword boundary.

,REQID=NO_REQID

,REQID=reqid

Use this input parameter to specify a user-defined request identifier to be associated with the request. You can specify this request identifier on the IXLPURGE macro to cancel a request that has not yet been processed.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an 8-byte field that contains the user-defined request identifier.

,REQTOKEN=reqtoken

Use this output parameter with either MODE=SYNCTOKEN or MODE=ASYNCTOKEN to specify the address of a storage area to receive the request token that is returned when the request will be processed asynchronously. This token, which uniquely identifies the request, must be used as input to the IXLFCOMP macro, which you use to determine if the request has completed.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field where the system will put the request token.

,RETCODE=retcode

Use this output parameter to specify a field to contain the return code. (The return code is also returned in register 15.)

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the return code when the request has completed.

,RSNCODE=rsncode

Use this output parameter to specify a field to contain the reason code returned, if applicable. (The reason code is also returned in register 0.)

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the reason code (if any) when the request has completed.

,SETCURSOR=HEAD

,SETCURSOR=TAIL

Use this input parameter to indicate that the list cursor and the list cursor direction are to be set.

Note: At the time the structure was allocated, the list cursor for each list in the structure was initialized to binary zeros. The default list cursor direction for all lists in the structure was set to a head-to-tail direction. Use this parameter only with a coupling facility of CFLEVEL=1 or higher.

SETCURSOR=HEAD: The list cursor is to be set to the entry identifier for the first entry on the list and the list cursor direction is to be set in a head-to-tail direction. If the list is empty, the list cursor is reset to binary zeros.
SETCURSOR=TAIL: The list cursor is to be set to the entry identifier for the last entry on the list and the list cursor direction is to be set in a tail-to-head direction. If the list is empty, the list cursor is reset to binary zeros.