Library: File system utilities (OMVFS) Import: omvfs.xmd

Declaration

export external function delete-file
                value string filename
        on      value directory on-dir optional

Argument definitions

filename

The path of the file to be deleted.

on-dir

A connected vfs.directory object. If this parameter is specified, the filename parameter is interpreted relative to the vfs.directory and must be expressed as a relative URL.

You can use vfs.delete-file to delete a file.

  import "omvfs.xmd" prefixed by vfs.
  process
    vfs.delete-file "c:\temp\myfile.txt"
    vfs.delete-file "hello.xml"

The specified file must exist or exception VFS306 is thrown.

Exceptions

The following exceptions may occur:

• VFS001 The requested function is not supported for the type of connection
• VFS004 The specified name 'X' exceeds system length limits
• VFS100 The vfsDir object must be connected before it can be used
• VFS105 The path 'X' is not a valid absolute or relative path
• VFS300 Generic operating system error
• VFS306 The file 'X' does not exist

Related Syntax    vfs.make-directory    vfs.delete-directory    vfs.link    vfs.copy    vfs.move    vfs.directory

Other Library Functions    vfs.change-directory    vfs.change-owner    vfs.change-permissions    vfs.close    vfs.connect    vfs.connect-directory    vfs.copy    vfs.cursor-position    vfs.default-certificates-file    vfs.delete-directory    vfs.delete-file    vfs.describe    vfs.describe-file    vfs.directory    vfs.directory-name    vfs.disconnect    vfs.file    vfs.file-directory    vfs.file-name    vfs.link    vfs.list    vfs.lock    vfs.make-directory    vfs.move    vfs.move-cursor    vfs.omvfs-version    vfs.open    vfs.open-file-system    vfs.open-ftp    vfs.open-http    vfs.open-https    vfs.reader    vfs.set-default-certificates-file    vfs.truncate    vfs.unlock    vfs.writer

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