Library: File system utilities (OMFSYS) legacy Include: omfsys.xin

Declaration

  define external function FS_Rename
                  value      stream  oldname
     to           value      stream  newname
     status       modifiable stream  statusvalue

The omfsys library has been deprecated and will be removed from a future version of the language. Use omvfs instead.

This function changes the name of a file, directory, or symbolic link.

Input arguments:

• "oldname" is the name of the existing file, directory, or symbolic link.
• "newname" is the new name of the file, directory, or symbolic link.

Output argument:

• "statusvalue". This contains either a zero length string if the function succeeds, or one of the following error codes in the current item:
  • "EACCESS" -- no search permission on a component of the path name
  • "EBUSY" -- the directory is the mount point of the file system
  • "EEXIST" -- a directory of the specified "newname" already exists and is not empty
  • "EINVAL" -- the new directory path name is invalid
  • "EISDIR" -- attempted to rename a file as a directory
  • "ELOOP" -- (UNIX only) a link recursion was detected
  • "ENAMETOOLONG" -- the path name exceeds system limits
  • "EMLINK" -- the link count of the parent directory would exceed system limits
  • "ENOENT" -- the file, directory, or link specified in "oldname" does not exist
  • "ENOSPC" -- the directory could not be extended
  • "ENOTDIR" -- the path name is not a valid directory
  • "EROFS" -- the file, directory, or link resides on a read-only file system
  • "EXDEV" -- the two files are on different logical devices
  • "EIO" -- a file system I/O error occurred

Note that "oldname" must specify a valid file, directory, or link, and that the user must have write access for the directories referred to by "oldname" and "newname". Also:

• If "oldname" refers to a file or link, "newname" cannot be a directory.
• If "newname" refers to an existing link, it will be replaced.
• If "oldname" refers to a directory, "newname" must be a directory.
• If "newname" refers to an existing directory, it must be empty.

Other Library Functions    FS_ChangeDirectory    FS_ChangeOwner    FS_ChangePermissions    FS_DeleteDirectory    FS_DeleteFile    FS_GetCurrentDirectory    FS_IsVersionCompatible    FS_LibraryVersion    FS_Link    FS_ListDirectory    FS_MakeDirectory    FS_Rename

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]