Description

A READ_MULT request allows you to read multiple entries from the list structure into the storage areas specified by ANSAREA and/or BUFLIST or BUFFER and/or ADJAREA. You can restrict processing to only those entries that satisfy either one or both of the following criteria:

Those residing on a certain list (which you specify using LISTNUM)
Those containing data that satisfies a version number comparison (which you specify using VERSCOMP).

For structures allocated in a CFLEVEL=0 coupling facility, if you specify neither LISTNUM nor VERSCOMP, every entry in the structure is read. The order in which the entries are read is unpredictable.

With a coupling facility of CFLEVEL=1 or higher, you can restrict processing to only those entries that satisfy one or more of the following criteria:

A successful comparison of the list authority value for the target list with a user-specified value. You specify the list authority requirements using AUTHCOMP and AUTHCOMPTYPE.
A successful comparison of the list entry key value that is being processed with a user-specified value (KEYCOMP).
A successful comparison of the version number, which is enhanced to include a less-than-or-equal comparison operation.

For each processed entry, any combination of the following types of data can be read depending on what you specify on the TYPE parameter:

List entry controls
Entry data
Adjunct data

If the request completes prematurely because it exceeds the coupling facility model-dependent time-out criteria or the specified buffer area (BUFFER or BUFLIST) is full, either a restart token (RESTOKEN) or an extended restart token (EXTRESTOKEN) is returned in the answer area (field LAARESTOKEN or LAAEXTRESTOKEN). The token can be specified on the next READ_MULT request to resume processing with the next data item to be processed. Resumed requests are processed identically whether using the RESTOKEN or EXTRESTOKEN to specify the starting location.