Exit Program for Get Stream File Size (QHFGETSZ) API

Before applications can use the Get Stream File Size (QHFGETSZ) API with your file system, you must:

1. Write an exit program that performs the get size operation on behalf of the API. For a detailed description of the API and its calling parameters, see Get Stream File Size (QHFGETSZ) 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 QHFGETSZ 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 parameter that the exit program must pass back to the API:

Operation (GETSZ)

INPUT; CHAR(5)

The abbreviation for the operation being performed (GETSZ).

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.

Open file handle

INPUT; CHAR(16)

File size

OUTPUT; BINARY(4) UNSIGNED

API Functions

The QHFGETSZ 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 and one additional function. The exit program should retrieve the size of the file as of the last write operation, excluding any object information stored with the file.

Error Messages for Exit Program Use

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