Exit Program for Create Directory (QHFCRTDR) API

Before applications can use the Create Directory (QHFCRTDR) API with your file system, you must:

1. Write an exit program that performs the create directory operation on behalf of the API. For a detailed description of the API and its calling parameters, see Create Directory (QHFCRTDR) 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 QHFCRTDR 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 (CRTDR)

INPUT; CHAR(5)

The abbreviation for the operation being performed (CRTDR).

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.

Length of path name

INPUT; BINARY(4)

Attribute information table

INPUT; CHAR(*)

Length of attribute information table

INPUT; BINARY(4)

API Functions

The QHFCRTDR API performs the standard functions described in Standard HFS API Functions and one additional function. The API verifies that the length of the attribute information table is not negative. It does not validate the attribute information in any way.

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:

• Supports user-defined attribute types.
  
  
• Validates the attribute information.
  
  
• Associates the specified attributes with the directory when it is created.
  
  
• Returns an exception without creating a directory if another user has the higher-level directory locked in deny write mode. (The higher-level directory is the directory in which the new directory is being created.)

Error Messages for Exit Program Use

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