Control File System (QHFCTLFS) API


  Required Parameter Group:

1 Open file handle Input Char(16)
2 File system name Input Char(10)
3 Input data buffer Input Char(*)
4 Input data buffer length Input Binary(4)
5 Output data buffer Output Char(*)
6 Output data buffer length Input Binary(4)
7 Length of data returned Output Binary(4)
8 Error code I/O Char(*)

  Default Public Authority: *USE

  Threadsafe: No

The Control File System (QHFCTLFS) API transmits commands to your file system to be performed. The commands must be defined by the file system.


Authorities and Locks

None.


Required Parameter Group

Open file handle
INPUT; CHAR(16)

The identifier returned when the file was opened with the Open Stream File (QHFOPNSF) API. If you specify a file system in the file system name parameter, this parameter is ignored.

File system name
INPUT; CHAR(10)

The registered file system to send the request to. Valid values are:

name The name of the registered file system. The open file handle parameter is ignored.
*HANDLE A special value indicating that the registered file system name is derived from the file handle provided in the open file handle parameter. Using the handle provides better performance than using the file system name.

Input data buffer
INPUT; CHAR(*)

The command string to send to the file system. This string differs from file system to file system. The QHFCTLFS API simply passes it on.

Input data buffer length
INPUT; BINARY(4)

The length of the input data buffer, in bytes.

Output data buffer
OUTPUT; CHAR(*)

The data returned from the file system.

Output data buffer length
INPUT; BINARY(4)

The length of the output data buffer, in bytes.

Length of data returned
OUTPUT; BINARY(4)

The length of the data returned by the file system in the output data buffer, in bytes.

Error code
I/O; CHAR(*)

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


Error Messages

Message ID Error Message Text
CPF1F05 E Directory handle not valid.
CPF1F25 E File handle not valid.
CPF1F41 E Severe error occurred while addressing parameter list.
CPF1F47 E Buffer overflow occurred.
CPF1F52 E Error code not valid.
CPF1F53 E Value for length of data buffer not valid.
CPF1F62 E Requested function failed.
CPF1F66 E Storage needed exceeds maximum limit for user profile &1.
CPF1F71 E Exception specific to file system occurred.
CPF1F72 E Internal file system error occurred.
CPF1F73 E Not authorized to use command.
CPF1F74 E Not authorized to object.
CPF1F75 E Error occurred during start-job-session function.
CPF1F81 E API specific error occurred.
CPF1F82 E Function not supported.
CPF1F83 E File system name &1 not found.
CPF1F85 E Not authorized to file system &1.
CPF1F87 E Missing or damaged exit program &2.
CPF1F97 E File system &1 in use.
CPF3C90 E Literal value cannot be changed.
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 ]