Exit Program for Rename Directory (QHFRNMDR) API

Required Parameter Group:

1	Operation (RNMDR)	Input	Char(5)
2	File system job handle	Input	Char(16)
3	Reserved	Input	Char(20)
4	Path name	Input	Char(*)
5	Path name length	Input	Binary(4)
6	New directory name	Input	Char(*)
7	New directory name length	Input	Binary(4)

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

Write an exit program that performs the rename directory operation on behalf of the API. For a detailed description of the API and its calling parameters, see Rename Directory (QHFRNMDR) API.
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 QHFRNMDR 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 (RNMDR): INPUT; CHAR(5)
The abbreviation for the operation being performed (RNMDR).
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)
New directory name: INPUT; CHAR(*)
New directory name length: INPUT; BINARY(4)

API Functions

The QHFRNMDR 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:

Verifies that the new directory does not already exist and that it has a different name from the old directory.
Verifies that the directory is not in use before renaming it.
Renames the directory.

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
CPF1F01 E	Directory name not valid.
CPF1F02 E	Directory not found.
CPF1F03 E	New directory name same as old directory name.
CPF1F04 E	Directory name already exists.
CPF1F06 E	Directory in use.
CPF1F07 E	Authority not sufficient to access directory.
CPF1F08 E	Damaged directory.
CPF1F09 E	Use of reserved directory name not allowed.
CPF1F41 E	Severe error occurred while addressing parameter list.
CPF1F48 E	Path name not valid.
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.
CPF1F75 E	Error occurred during start-job-session function.
CPF1F77 E	Severe parameter error occurred on call to file system.

Exit Program Introduced: V2R1

Top | Hierarchical File System APIs | APIs by category