s_rename_file

Changes the pathname of a named directory or data file, including remote and DOS. It cannot be used for stream or physical files.

/Note

When you rename a directory, you change the paths for all files and other directories contained in the directory.

Syntax, PL/M and C

CALL rq$s$rename$file (path_ptr, new_path_ptr, except_ptr);

rq_s_rename_file (path_ptr, new_path_ptr, except_ptr);

Parameters

path_ptr
A pointer to a STRING that specifies the current path for an existing file or directory to be renamed.

new_path_ptr
A pointer to a STRING that specifies the new path for the file. This path must comply with the syntax and semantics of paths for named files. This path cannot refer to an existing file.

See also:Paths, System Concepts

except_ptr
A pointer to a variable declared by the application where the call returns a condition code.

Additional Information

A task can change any aspect of a directory's or file's path so long as it remains on the same volume.

DOS users cannot rename a directory as a subdirectory. The DOS World user must have write access to the file to rename it; write (delete, append, update, add-entry, and change-entry) access is optional.

The iRMX default user object of the calling task's job must have deletion access to the original file and add-entry access to the file's new parent directory.

See also:s_change_access, BIOS call a_change_access

S_rename_file cannot rename these iRMX-NET entries:

·A file in a virtual root directory

·A virtual root directory

·A public directory

The remote directory's or file's access rights are checked during operations on the connection. This won't affect your programs if you:

·Open, delete, and rename prior to changing access lists.

·Establish connections after changing access lists.

Condition Codes