List Registered File Systems (QHFLSTFS) API

The List Registered File Systems (QHFLSTFS) API returns information similar to the Display Hierarchical File Systems (DSPHFS) command. The QHFLSTFS API retrieves a list of all file systems that are currently registered and thus available for use through the HFS APIs. The list gives the name, version level, and text description for each file system.

Authorities and Locks

None.

Required Parameter Group

Qualified user space name

INPUT; CHAR(20)

The name of the *USRSPC object that is to receive the generated list. The first 10 characters give the user space name, and the second 10 characters give the name of the library in which the user space resides. 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 format of the information returned. You must use this format name:

HFSL0100

File system list. For details, see HFSL0100 Format.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.

HFSL0100 Format

The HFSL0100 file system list consists of:

• A user area
  
  
• A generic header
  
  
• An input parameter section
  
  
• A list data section

The user area and generic header are described in the User spaces. When you retrieve list entry information from a user space and you want to increase pointer values or add to variables used in the QUSRTVUS API, you must use the entry size returned in the generic header. The entries can be padded at the end.

The input parameter and list data sections are specific to the HFSL0100 format. They are described below. For a detailed description of each item, see Field Descriptions.

Input Parameter Section

Offset		Type	Information
Dec	Hex
0	0	CHAR(10)	User space name
10	A	CHAR(10)	User space library name
20	14	CHAR(8)	Format name

List Data Section

Offset		Type	Information
Dec	Hex
0	0	CHAR(10)	File system name
10	A	CHAR(6)	Version
16	10	CHAR(50)	Text description

Field Descriptions

File system name. The name of the file system when it was registered.

Format name. The format of the returned output.

Text description. The description of the file system specified at registration time.

User space library name. The name of the library containing the user space.

User space name. The name of the user space that receives the list.

Version. The version the file system supports. This is in the form VxRxMx, where x represents the version, release, and modification levels, respectively.

Error Messages

Message ID	Error Message Text
CPF1F41 E	Severe error occurred while addressing parameter list.
CPF1F52 E	Error code not valid.
CPF1F66 E	Storage needed exceeds maximum limit for user profile &1.
CPF1F81 E	API specific error occurred.
CPF3C21 E	Format name &1 is not valid.
CPF3C90 E	Literal value cannot be changed.
CPF8100 E	All CPF81xx messages could be returned. xx is from 01 to FF.
CPF9801 E	Object &2 in library &3 not found.
CPF9802 E	Not authorized to object &2 in &3.
CPF9803 E	Cannot allocate object &2 in library &3.
CPF9807 E	One or more libraries in library list deleted.
CPF9808 E	Cannot allocate one or more libraries on library list.
CPF9810 E	Library &1 not found.
CPF9820 E	Not authorized to use library &1.
CPF9830 E	Cannot assign library &1.
CPF9838 E	User profile storage limit exceeded.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

---

API introduced: V2R1

---

[ Back to top | Hierarchical File System APIs | APIs by category ]