Exit Program for Control File System (QHFCTLFS) API


  Required Parameter Group:

1 Operation (CTLFS) Input Char(5)
2 File system job handle Input Char(16)
3 File handle Input Char(16)
4 Input data buffer Input Char(*)
5 Input data buffer length Input Binary(4)
6 Output data buffer Output Char(4)
7 Output data buffer length Input Binary(4)
8 Length of data returned Output Binary(4)

Before applications can use the Control File System (QHFCTLFS) API with your file system, you must:

  1. Write an exit program that performs the control file system operation on behalf of the API. For a detailed description of the API and its calling parameters, see Control File System (QHFCTLFS) API.

  2. Give the exit program's name when you register the file system with the Register File System (QHFRGFS) API.

After that, when an application calls the QHFCTLFS API, the API calls your exit program and passes it the parameters specified by the application. Your exit program performs the work and returns any data to the API. The API passes the data back to the calling application.


Authorities and Locks

None.


Required Parameter Group

The following shows the input parameters that the API passes to your exit program and the output parameters that the exit program must pass back to the API:

Operation (CTLFS)
INPUT: CHAR(10)

The abbreviation for the operation being performed (CTLFS).

File system job handle
INPUT; CHAR(16)

The work area or job identifier for use by the file system.

The following parameters are the same as the parameters for the API:

File handle
INPUT; CHAR(16)

Input data buffer
INPUT; CHAR(*)

Input data buffer length
INPUT; BINARY(4)

Output data buffer
OUTPUT; CHAR(*)

Output data buffer length
INPUT; BINARY(4)

Length of data returned
OUTPUT; BINARY(4)

API Functions

The QHFCTLFS API performs the standard functions described in Standard HFS API Functions.


Exit Program Requirements

You must create an exit program that performs the standard functions described in Standard HFS Exit Program Requirements.


Error Messages for Exit Program Use

This section lists the messages that the exit program can return to the API.

Message ID Error Message Text
CPF1F41 E Severe error occurred while addressing parameter list.
CPF1F47 E Buffer overflow occurred.
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.
CPF1F73 E Not authorized to use command.
CPF1F74 E Not authorized to object.
CPF1F75 E Error occurred during start-job-session function.
CPF1F77 E Severe parameter error occurred on call to file system.

Exit Program Introduced: V2R1
Top | Hierarchical File System APIs | APIs by category