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

Declaration

  define external function FS_ChangeDirectory
                  value      stream  newpath
     status       modifiable stream  statusvalue

Argument definitions

newpath

is the absolute or relative path name of the new directory (input argument)

statusvalue

is an argument containing either a zero length string if the function succeeds, or one of the error codes listed in the Usage Notes section.

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

Use FS_ChangeDirectory to set the current (working) directory.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omfsys.xin"

Usage Notes

Note that "newpath" must refer to a valid path name, and you must have execute (search) access to the specified directory.

The statusvalue output argument will contain either a zero length string if the function succeeds, or one of the following error codes:

• "EACCES" -- no search permission on a component of the path name
• "EINTR" -- a signal was caught during the function execution
• "EIO" -- a file system I/O error occurred
• "ELOOP" -- (UNIX only) link recursion was detected
• "ENAMETOOLONG" -- the path name exceeds the system limits
• "ENOENT" -- the specified path does not exist
• "ENOLINK" -- (UNIX only) a required link to a remote machine is inactive
• "ENOTDIR" -- the path name is not a valid directory
• "EMULTIHOP" -- (UNIX only) remote machine access is required but not allowed

Example

This example sets the working directory to "C:\temp"" and outputs an error message if any error occurs.

  ; FS_ChangeDirectory
  include "omfsys.xin"

  process

     local stream error
     local stream location initial {"C:\temp"}

     FS_ChangeDirectory location status error
     output "Error " || error || " changing to directory "
        || location || "%n" unless error = ""

Related Syntax    FS_GetCurrentDirectory

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 ]