Exit Program for Set Stream File Size (QHFSETSZ) API


  Required Parameter Group:

1 Operation (SETSZ) Input Char(5)
2 File system job handle Input Char(16)
3 Open file handle Input Char(16)
4 File size Input Binary(4) Unsigned

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

  1. Write an exit program that performs the set size operation on behalf of the API. For a detailed description of the API and its calling parameters, see Set Stream File Size (QHFSETSZ) 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 QHFSETSZ 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 (SETSZ)
INPUT; CHAR(5)

The abbreviation for the operation being performed (SETSZ).

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
INPUT; BINARY(4) UNSIGNED

API Functions

The QHFSETSZ 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 these additional functions:


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
CPF1F2B E Write operation not allowed to file opened for read only.
CPF1F2E E Range of bytes in file in use.
CPF1F28 E Damaged file.
CPF1F4B E Value for number of bytes not valid.
CPF1F41 E Severe error occurred while addressing parameter list.
CPF1F61 E No free space available on media.
CPF1F62 E Requested function failed.
CPF1F63 E Media is write protected.
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.
CPF1F77 E Severe parameter error occurred on call to file system.


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