Description

A list structure is a coupling facility structure that enables multisystem application to share information organized as a set of lists and an optional set of locks. Each list consists of a queue of list entries.

The IXLLIST macro provides the means for applications in a sysplex to access and manipulate the data in a coupling facility list structure.

The IXLLIST macro provides many services. The service you require is designated by the REQUEST parameter. These services are detailed in other topics.

Starting with OS/390® Release 9, functions provided by the IXLLIST macro are supplemented with three additional macros — IXLLSTC, IXLLSTE, and IXLLSTM, that applications can use to access and manipulate the data in a coupling facility list structure. IXLLIST invocations will continue to be supported after OS/390 Release 8, but any new functionality will be added to the three new macros.

Be sure to read the IXLLIST guidance information in z/OS MVS Programming: Sysplex Services Guide. The information presented here assumes you have done so. Table 1 tells you where to find the reference information for each IXLLIST request type and indicates the OS/390 Release 9 new list services macro that provides the same, and possibly additional, functionality:

Table 1. Request Types for IXLLIST
Request Type	Description
DELETE	Delete a list entry from a coupling facility list structure. You can also read an entry into your buffer and delete it from the coupling facility list structure. See also IXLLSTE REQUEST=DELETE. See IXLLIST REQUEST=DELETE.
DELETE_ENTRYLIST	Delete multiple list entries that are designated in an entry list contained in the storage area specified by BUFLIST or BUFFER. See also IXLLSTM REQUEST=DELETE_ENTRYLIST. See IXLLIST REQUEST=DELETE_ENTRYLIST.
DELETE_MULT	Delete multiple list entries from a coupling facility list structure. See also IXLLSTM REQUEST=DELETE_MULT. See IXLLIST REQUEST=DELETE_MULT.
DEQ_EVENTQ	Read and dequeue event monitor controls from your event queue. See also IXLLSTC REQUEST=DEQ_EVENTQ. See IXLLIST REQUEST=DEQ_EVENTQ.
LOCK	Perform locking functions such as SET, RESET, TEST, READNEXT. See also IXLLSTC REQUEST=LOCK. See IXLLIST REQUEST=LOCK.
MONITOR_EVENTQ	Start or stop monitoring your event queue for the presence of event monitor controls. See also IXLLSTC REQUEST=MONITOR_EVENTQ. See IXLLIST REQUEST=MONITOR_EVENTQ.
MONITOR_LIST	Start or stop monitoring a specified list for the presence of entries. See also IXLLSTC REQUEST=MONITOR_LIST. See IXLLIST REQUEST=MONITOR_LIST.
MONITOR_SUBLIST	Start or stop monitoring a specified sublist for the presence of entries. See also IXLLSTC REQUEST=MONITOR_SUBLIST. See IXLLIST REQUEST=MONITOR_SUBLIST.
MONITOR_SUBLISTS	Start monitoring a set of sublists for the presence of entries. See also IXLLSTC REQUEST=MONITOR_SUBLISTS. See IXLLIST REQUEST=MONITOR_SUBLISTS.
MOVE	Allows you to move an existing list entry from one list to another list or within the same list. You can also create a new list entry and place it on a list and write data to it. It is also possible to move an entry and read it into your buffer. See also IXLLSTE REQUEST=MOVE. See IXLLIST REQUEST=MOVE.
READ	Read a list entry from the coupling facility list structure into the storage areas specified by BUFFER or BUFLIST and/or ADJAREA. See also IXLLSTE REQUEST=READ. See IXLLIST REQUEST=READ.
READ_EMCONTROLS	Retrieve control information about a sublist you are monitoring. See also IXLLSTC REQUEST=READ_EMCONTROLS. See IXLLIST REQUEST=READ_EMCONTROLS.
READ_EQCONTROLS	Retrieve control information about your event queue. See also IXLLSTC REQUEST=READ_EQCONTROLS. See IXLLIST REQUEST=READ_EQCONTROLS.
READ_LCONTROLS	Retrieve list control and monitoring information for a specified list. See also IXLLSTC REQUEST=READ_LCONTROLS. See IXLLIST REQUEST=READ_LCONTROLS.
READ_LIST	Read multiple entries from a single list into the storage areas specified by BUFFER or BUFLIST and/or ADJAREA and ANSAREA. See also IXLLSTM REQUEST=READ_LIST. See IXLLIST REQUEST=READ_LIST.
READ_MULT	Read multiple entries from the coupling facility list structure into the storage areas specified by BUFFER or BUFLIST and/or ADJAREA and ANSAREA. See also IXLLSTM REQUEST=READ_MULT. See IXLLIST REQUEST=READ_MULT.
WRITE	Write data from the storage areas specified by BUFFER or BUFLIST and/or ADJAREA to a list entry in the coupling facility list structure. See also IXLLSTE REQUEST=WRITE. See IXLLIST REQUEST=WRITE.
WRITE_LCONTROLS	Modify list controls for the specified list. This includes the list authority, list limit, list description, list cursor, list key, and maximum list key. See also IXLLSTC REQUEST=WRITE_LCONTROLS. See IXLLIST REQUEST=WRITE_LCONTROLS.