vfs.link

function

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

Declaration

export external function link
                value string path
        on      value directory on-dir optional
        to      value string linkname
        in      value directory link-dir optional

Argument definitions

path: The file or directory target of the link.

on-dir: A connected vfs.directory object. If this parameter is specified, the path parameter is interpreted relative to the vfs.directory and must be expressed as a relative URL.

linkname: The name of the symbolic link.

link-dir: A connected vfs.directory object. If this parameter is specified, the linkname parameter is interpreted relative to the vfs.directory and must be expressed as a relative URL.

Purpose

You can use vfs.link to create a symbolic link for a file or directory. vfs.link works only on a UNIX platform.

  import "omvfs.xmd" prefixed by vfs.
  
  process
      vfs.link "../myFiles/holland.txt"
          to "ozfile.txt"

Exceptions

The following exceptions may occur:

VFS001 The requested function is not supported for the type of connection
VFS002 The requested function is only available on UNIX platforms
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
VFS307 The path 'X' exists