Rename Stream File (QHFRNMSF) API

Required Parameter Group:

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

Default Public Authority: *USE

Threadsafe: No

The Rename Stream File (QHFRNMSF) API renames a stream file in the same path.

Authorities and Locks

None.

Required Parameter Group

Path name

INPUT; CHAR(*)

The path name for the file being renamed. The last element of the path name is the name of the file.

The file cannot be open or in use.

Path name length

INPUT; BINARY(4)

The length of the path name, in bytes.

New file name

INPUT; CHAR(*)

The new name for the file. Do not include the path.

The new name must be unique within a directory. A file with this name cannot already exist in the target directory.

New file name length

INPUT; BINARY(4)

The length of the new file 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.
CPF1F06 E	Directory in use.
CPF1F07 E	Authority not sufficient to access directory.
CPF1F08 E	Damaged directory.
CPF1F21 E	File name not valid.
CPF1F22 E	File not found.
CPF1F23 E	New file name same as old file name.
CPF1F24 E	File name already exists.
CPF1F26 E	File in use.
CPF1F27 E	Authority not sufficient to access file.
CPF1F28 E	Damaged file.
CPF1F29 E	Use of reserved file 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.

CPF1F06 E

Directory in use.

CPF1F07 E

Authority not sufficient to access directory.

CPF1F08 E

Damaged directory.

CPF1F21 E

File name not valid.

CPF1F22 E

File not found.

CPF1F23 E

New file name same as old file name.

CPF1F24 E

File name already exists.

CPF1F26 E

File in use.

CPF1F27 E

Authority not sufficient to access file.

CPF1F28 E

Damaged file.

CPF1F29 E

Use of reserved file 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.