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

Declaration

define external function FS_DeleteFile
                value      stream  currentpath
   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 remove a specified file from the file system.

Input argument:

• "currentpath" is the name and location of the file to delete. If "currentpath" refers to a link, the link entry is removed.

Output argument:

• "statusvalue". This contains either a zero length string when the function succeeds, or one of the following error codes:
  • "EACCES" -- no search permission on a component of the path name
  • "EBUSY" -- the file or link is the mount point for the file system
  • "EINTR" -- a signal was caught while the function was executing
  • "ELOOP" -- (UNIX only) a link recursion was detected
  • "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
  • "ENOTDIR" -- the path name is not a valid directory
  • "EPERM" -- the user does not have the required permission
  • "EROFS" -- the files resides on a read-only file system

Note that "currentpath" must be a valid file name, and the user must have sufficient permissions on the files and directories involved.

Related Syntax FS_DeleteDirectory

Other Library Functions

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