Exit Program for Force Buffered Data (QHFFRCSF) API

Before applications can use the Force Buffered Data (QHFFRCSF) API with your file system, you must:

1. Write an exit program that performs the force operation on behalf of the API. For a detailed description of the API and its calling parameters, see Force Buffered Data (QHFFRCSF) 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 QHFFRCSF 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 API passes this information to your exit program:

Operation (FRCSF)

INPUT; CHAR(5)

The abbreviation for the operation being performed (FRCSF).

File system job handle

INPUT; CHAR(16)

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

The following parameter is the same as the parameter for the API.

Files to force

INPUT; CHAR(16)

API Functions

The QHFFRCSF API performs the standard functions described in Standard HFS API Functions and these additional functions:

• It verifies that the files to force parameter gives either a valid open file handle or hexadecimal zeros to indicate all files.
  
  
• If one file is specified, it calls the appropriate file system to force the data. Any exceptions received from the file system are either resignaled or mapped into an error code, as the application requests.
  
  
• If all files are specified, it calls each file system used by the process once for each open file within that file system to force the data for that file. Any exceptions received from the file system are left in the job log, and the API continues processing the remaining open files until all are forced. Any exceptions are reported to the caller as a special error condition indicating that the attempt to force all files partially failed.

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.