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

Declaration

  export external function delete-directory
                  value stream path
          on      value directory on-dir optional
          contents value switch contents optional initial {contents-not-included}

Argument definitions

path

The directory to be deleted

dir

A connected vfs.directory object. It this parameter is specified, the path parameter is interpreted relative to the vfs.directory and must be in URL format.

contents

A switch indicating if the directory contents are to be deleted. The default is that directory contents are not to be deleted (contents-not-included).

You can use vfs.delete-directory to remove an existing directory. The following program will remove a directory and all its contents from the local file system.

  import "omvfs.xmd" prefixed by vfs.

  process
    vfs.delete-directory "/Program Files/Games/oldVersions"
    contents vfs.contents-included

If you want the contents of the directory to be deleted, you must specify the contents parameter with a value of vfs.contents-included. If vfs.contents-included is not specified, and the directory is not empty, exception VFS305 will be thrown and the directory will not be deleted.

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
• VFS301 The directory 'X' does not exist
• VFS305 The directory 'X' is not empty

Related Syntax    vfs.make-directory    vfs.delete-file    vfs.link    vfs.copy    vfs.move    vfs.change-directory    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 ] [ LEGACYLIBRARIES ] [ ERRORS ]