Rename Directory (QHFRNMDR) API

Required Parameter Group:

1	Path name	Input	Char(*)
2	Path name length	Input	Binary(4)
3	New directory name	Input	Char(*)
4	New directory name length	Input	Binary(4)
5	Error code	I/O	Char(*)

Default Public Authority: *USE

Threadsafe: No

The Rename Directory (QHFRNMDR) API renames a single directory. You cannot rename the directory if another job has already opened it. (When a job opens a directory with the Open Directory (QHFOPNDR) API, it specifies a lock mode. The lock mode specifies what other jobs are allowed to do to the directory while the first job has it open.)

Authorities and Locks

None.

Required Parameter Group

Path name

INPUT; CHAR(*)

The path name of the directory being renamed. The last element of the path name must be a directory name. You cannot use a one-element path name specifying only the file system.

Path name length

INPUT; BINARY(4)

The length of the path name, in bytes.

New directory name

INPUT; CHAR(*)

The new name for the directory. Specify only the directory name. Do not specify the path name.

New directory name length

INPUT; BINARY(4)

The length of the new directory name, in bytes.

Error code

I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error Code Parameter.

Error Messages

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.
CPF1F52 E	Error code 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.
CPF1F72 E	Internal file system error occurred.
CPF1F73 E	Not authorized to use command.
CPF1F74 E	Not authorized to object.
CPF1F75 E	Error occurred during start-job-session function.
CPF1F81 E	API specific error occurred.
CPF1F82 E	Function not supported.
CPF1F83 E	File system name &1 not found.
CPF1F85 E	Not authorized to file system &1.
CPF1F87 E	Missing or damaged exit program &2.
CPF1F97 E	File system &1 in use.
CPF3C90 E	Literal value cannot be changed.
CPF9872 E	Program or service program &1 in library &2 ended. Reason code &3.

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.

CPF1F52 E

Error code 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.

CPF1F72 E

Internal file system error occurred.

CPF1F73 E

Not authorized to use command.

CPF1F74 E

Not authorized to object.

CPF1F75 E

Error occurred during start-job-session function.

CPF1F81 E

API specific error occurred.

CPF1F82 E

Function not supported.

CPF1F83 E

File system name &1 not found.

CPF1F85 E

Not authorized to file system &1.

CPF1F87 E

Missing or damaged exit program &2.

CPF1F97 E

File system &1 in use.

CPF3C90 E

Literal value cannot be changed.

CPF9872 E

Program or service program &1 in library &2 ended. Reason code &3.