vfs.move

function

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

Declaration

export external function move
                value string source-path
        on      value directory source-dir optional
        to      value string target-path
        in      value directory target-dir optional

Argument definitions

source-path: The path to the directory or file to be moved.

source-dir: A connected VFS directory object. If this parameter is specified, the source-path parameter is interpreted relative to the vfs.directory and must be in the form of a relative URL.

target-path: The path to the target directory or file for the move.

target-dir: A connected VFS directory object. If this parameter is specified, the target-path parameter is interpreted relative to the vfs.directory and must be in the form of a relative URL.

Purpose

You can use vfs.move to move a file or a directory (including all subdirectories and files) to a new location.

  import "omvfs.xmd" prefixed by vfs.
  
  process
    vfs.move "c:/omnimark/projects/vfstest"
    to "c:/omnimark/archive"

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
VFS111 The URL 'X' contains invalid encoding
VFS300 Generic operating system error
VFS306 The file 'X' does not exist
VFS307 The path 'X' exists

Troublshooting

See vfs.copy for a discussion of the difficulties that can occur when specifying the destination of a move or copy operation.