A READ_COCLASS request allows you to read directory entry names and directory entry user data entries associated with a specified cast-out class (COCLASS). You may filter the cast-out class information by specifying the NAME and NAMEMASK parameters. You may limit the amount of information returned with the DIRINFOFMT parameter. The retrieved information is stored in the storage areas specified by BUFLIST or BUFFER. For structures allocated in a coupling facility of CFLEVEL=4 or lower, the format of the returned information is described by mapping macro IXLYCANB.

For structures allocated in a coupling facility of CFLEVEL=5 or higher, the format of the returned information is described by either mapping macro IXLYCANB or mapping macro IXLYDEIB, depending on the value specified for the DIRINFOFMT keyword.

The number of directory entry name elements (names and user data) that are retrieved is provided in the answer area (ANSAREA). The answer area is described by the IXLYCAA mapping macro.

If the request completes prematurely because it exceeds the model-dependent time-out criteria or the specified buffer area (BUFLIST or BUFFER) is full, a restart token (RESTOKEN) or an extended restart token (EXTRESTOKEN) is returned in the answer area (fields CAARESTOKEN or CAAEXTRESTOKEN). The token can be specified on the next READ_COCLASS request to resume processing with the next directory entry to be processed. Resumed requests are processed identically whether using the RESTOKEN or EXTRESTOKEN to specify the starting location.