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

Declaration

  define external function FS_Link
                  value      stream  existing
     to           value      stream  newone
     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 will create a symbolic link to an existing file or directory.

Input arguments:

• "existing" is the path name of the existing file or directory to which you want to create the link.
• "newone" is the name of the link you are creating.

Output argument:

• "statusvalue". This will contain either a zero length string if the function is successful, or one of the following error codes in the current item:
  • "EACCES" -- no search permission on a component of the path name
  • "EEXIST" -- the link specified in "newone" already exists
  • "EINTR" -- a signal was caught while the function was executing
  • "ELOOP" -- (UNIX only) a link recursion was detected
  • "EMLINK" -- the file link maximum would be exceeded by the creation of this link
  • "EMULTIHOP" -- (UNIX only) remote machine access is required, but not allowed
  • "ENAMETOOLONG" -- the path name exceeds system limits
  • "ENOENT" -- the specified path or file does not exist
  • "ENOLINK" -- (UNIX only) a required link to a remote machine is inactive
  • "ENOSPC" -- the directory could not be extended
  • "ENOTDIR" -- the specified path is not a valid directory
  • "EPERM" -- the user does not have the required permission
  • "EROFS" -- the file resides on a read-only file system
  • "EXDEV" -- the two files are on different logical devices

Note that "existing" must be a valid reference to an existing file or directory. Also, only the system super-user can create a link to a directory, and both files must be on the same system.

Related Syntax    FS_DeleteFile

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 ]