Exit Program for Delete Stream File (QHFDLTSF) API

Before applications can use the Delete Stream File (QHFDLTSF) API with your file system, you must:

1. Write an exit program that performs the delete stream file operation on behalf of the API. For a detailed description of the API and its calling parameters, see Delete Stream File (QHFDLTSF) 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 QHFDLTSF 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 (DLTSF)

INPUT; CHAR(5)

The abbreviation for the operation being performed (DLTSF).

File system job handle

INPUT; CHAR(16)

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

Reserved

INPUT; CHAR(20)

Reserved for future use. This parameter is set to blanks.

Except as noted, the following parameters are the same as the parameters for the API.

Path name

INPUT; CHAR(*)

The API removes the file system name before passing the path name to the exit program.

Path name length

INPUT; BINARY(4)

API Functions

The QHFDLTSF API performs the standard functions described in Standard HSF 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:

• Ensures that the file being deleted is not open or in use.
  
  
• Ensures that the file being deleted is not a read-only file.

Error Messages for Exit Program Use

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