Full text search
function	FS_DeleteDirectory

Library: File System Utilities Include: omfsys.xin

Declaration

  define external function FS_DeleteDirectory
                  value      stream  newpath
     status       modifiable stream  statusvalue 

This function allows you to remove a directory from the file system.

Input argument:

• "newpath". The path name of the directory to be removed.

Output argument:

• "statusvalue". This will contain either a zero length string if the function succeeds, or one of the following error codes in the current item:
  • "FAILURE" -- (NT only) the operation failed
  • "EACCES" -- (UNIX only) the user does not have sufficient permission for the path
  • "EBUSY" -- (UNIX only) the directory is the mount point for the file system
  • "EEXIST" -- (UNIX only) the directory is not empty
  • "EINVAL" -- (UNIX only) an attempt was made to delete the current directory
  • "EIO" -- (UNIX only) a file system I/O error occurred
  • "ELOOP" -- (UNIX only) link recursion was detected
  • "EMULTIHOP" -- (UNIX only) remote machine access is required, but not allowed
  • "ENAMETOOLONG" -- (UNIX only) the path name exceeds system limits
  • "ENOENT" -- (UNIX only) the specified path does not exist
  • "ENOLINK" -- (UNIX only) a required link to a remote machine is inactive
  • "ENOTDIR" -- (UNIX only) the pathname is not a valid directory
  • "EROFS" -- (UNIX only) the file resides on a read-only file system

Note that "newpath" must reference a valid directory, and the directory being deleted must be empty.