Exit Program for Retrieve Directory Entry Attributes (QHFRTVAT) API

Before applications can use the Retrieve Directory Entry Attributes (QHFRTVAT) API with your file system, you must:

1. Write an exit program that performs the retrieve attributes operation on behalf of the API. For a detailed description of the API and its calling parameters, see Retrieve Directory Entry Attributes (QHFRTVAT) 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 QHFRTVAT 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 (RTVAT)

INPUT; CHAR(5)

The abbreviation for the operation being performed (RTVAT).

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)

Attribute selection table

INPUT; CHAR(*)

Length of the attribute selection table

INPUT; BINARY(4)

Attribute information table

OUTPUT; CHAR(*)

Length of the attribute information table

INPUT; BINARY(4)

Length of data returned

OUTPUT; BINARY(4)

API Functions

The QHFRTVAT API performs the standard functions described in Standard HFS API Functions. The API does not validate the attribute selection table, the attribute information table, or the length of the attribute information table.

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:

• Validates the attribute selection table.
  
  
• Builds the attribute information table to return the requested attributes to the application.

Error Messages for Exit Program Use

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