List Database File Members (QUSLMBR) API

The List Database File Members (QUSLMBR) API generates a list of database file members and places the list in a specified user space. When you specify a generic member name, you can generate a subset of the member list. You can use the QUSLMBR API with database file types *PF, *LF, and *DDMF. The generated list replaces any existing information in the user space. The file members listed in the user space are not in any predictable order. To retrieve additional information about each member in the list, see the Retrieve Member Description (QUSRMBRD) API.

You can use the QUSLMBR API to:

• List members more quickly than by using the *MBRLIST value on the TYPE parameter of the Display File Description (DSPFD) command.
• Retrieve information for all of the members of a database file more quickly and easily than by multiple calls to the Retrieve Member Description (QUSRMBRD) API. It is your discretion to decide which API best suits the needs of your application. For example, if you want to selectively retrieve member descriptions for a subset of the member list, you might want to use both the QUSLMBR and QUSRMBRD APIs.
• Ensure that the last date the source was changed matches the date of the source used to create the object.

Authorities and Locks

User Space Authority

*CHANGE

User Space Library Authority

*EXECUTE

File Authority

*OBJOPR

User Space Lock

*EXCLRD

File Lock

*SHRRD

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The user space that is to receive the created list. The first 10 characters contain the user space name, and the second 10 characters contain the name of the library where the user space is located. You can use these special values for the library name:

*CURLIB	The job's current library
*LIBL	The library list

Format name

INPUT; CHAR(8)

The content and format of the information returned for each member. The possible format names are:

MBRL0100	Member name
MBRL0200	Member name and source information This format requires more processing than the MBRL0100 format.
MBRL0310	Member name and basic description. The member information is the same as that generated by the Retrieve Member Description (QUSRMBRD) API using format MBRD0100. This format requires more system processing and takes longer to produce than the MBRL0200 format.
MBRL0320	Member name and expanded description. The member information is the same as that generated by the Retrieve Member Description (QUSRMBRD) API using format MBRD0200. The additional information requires more system processing and takes longer to produce than the MBRL0310 format.
MBRL0330	Member name and full description. The member information is the same as that generated by the Retrieve Member Description (QUSRMBRD) API using format MBRD0300. The additional information requires more system processing and takes longer to produce than the MBRL0320 format.
For more information, see MBRL0100 List Data Section, MBRL0200 List Data Section, or MBRL0300 List Data Section.

Qualified database file name

INPUT; CHAR(20)

The name of the database file whose member names are to be placed in the list. The first 10 characters contain the database file name, and the second 10 characters contain the name of the library where the file is located. You can use these special values for the library name:

*CURLIB	The job's current library
*LIBL	The library list

Member name

INPUT; CHAR(10)

A specific member name, a generic member name, or this special value:

*ALL	All members

Override processing

INPUT; CHAR(1)

Whether overrides are to be processed. The following character values are used:

0	No override processing
1	Override processing

Optional Parameter

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.

Format of the Generated Lists

The file member list consists of:

• A user area
• A generic header
• An input parameter section
• A header section
• A list data section:
  • MBRL0100 format
  • MBRL0200 format
  • MBRL0300 format

The MBRL0300 list data section is generated if MBRL0310, MBRL0320, or MBRL0330 is specified as the format name parameter.

For details about the user area and generic header, see User Space Format for List APIs. For details about the remaining items, see the following sections. For detailed descriptions of the fields in the list returned, see Field Descriptions.

When you retrieve list entry information from a user space, you must use the entry size returned in the generic header as a displacement to the next list entry. The size of each entry may be padded at the end. If you do not use the entry size, the result may not be valid. For examples of how to process lists, see Examples.

Input Parameter Section

Header Section

MBRL0100 List Data Section

MBRL0200 List Data Section

MBRL0300 List Data Section

The MBRL0300 format provides an offset to a retrieved member description. When the member description information cannot be retrieved, the Offset to member description information will be returned as an offset of zero and the message indicating why the information could not be currently retrieved will be left in the Job Log. Also, no Error Code Parameter, or escape messages will be issued to the application when the member description information cannot be retrieved. The member descriptions have the same format as those generated by the Retrieve Member Description (QUSRMBRD) API. The following relationship exists between the QUSLMBR format name and the QUSRMBRD member descriptions:

• MBRL0310 generates an MBRD0100 description.
• MBRL0320 generates an MBRD0200 description.
• MBRL0330 generates an MBRD0300 description.

For more information about the member description formats, see Retrieve Member Description (QUSRMBRD) API.

Offset		Type	Field
Dec	Hex
0	0	CHAR(10)	Member name used
10	A	CHAR(2)	Reserved
12	C	BINARY(4)	Offset to member description information (an offset of zero indicates that no information was retrieved)
16	10	CHAR(16)	Reserved

Field Descriptions

Creation date and time. The date and time the member was created. The format of this field is in the CYYMMDDHHMMSS as follows:

File attribute. The type of file found:

File library name specified. The name of the library containing the file whose member names are to be placed in the list.

File library name used. The name of the library containing the file whose member names are placed in the list.

File name specified. The name of the file specified in the call to the API.

File name used. The name of the file whose member names are placed in the list.

File text description. The description of the file.

File text description CCSID. The CCSID for the file text description. The job default CCSID of the current process will be used to translate the text. For more information about CCSID, see the Globalization topic.

Format name. The content and format of the information returned for each member.

Last source change or table refresh date and time. For source files, the date and time that this source member was last changed. For SQL materialized query tables, the date and time that the last SQL Refresh Table statement refreshed this member. If the member has never been refreshed, this field will contain hexadecimal zeroes. This field is in the CYYMMDDHHMMSS format where the format is the same as for the creation date and time field.

Member name specified. The name of the member specified in the call to the API.

Member name used. The name of a member found in the file.

Member text description. Description of the member found in the file.

Member text description CCSID. The CCSID for the member text description. The job default CCSID of the current process will be used to translate the text. For more information about CCSID, see the Globalization topic.

Offset to member description information. The number of bytes from the beginning of the user space to the beginning of the retrieved member description.

Override processing. Whether overrides are to be processed. The possible values are:

Reserved. An ignored field.

Source file. Whether the file is a source file or a data file. The possible values are:

Source type. The type of source member if this is a source file. Some possible values are:

• CL
• COBOL
• RPG
• TXT

Total number of members in file. The total number of members in the file specified.

User space library name. The name of the library that contains the user space that is to receive the generated list.

User space name. The name of the user space that is to receive the generated list.

Usage Notes

In multithreaded jobs, this API is not threadsafe and fails for distributed data management (DDM) files of type *SNA.

Error Messages