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

Return type: directory Returns: The VFS directory connected to the location containing file if file was opened using an URL.

Declaration

export external directory function file-directory
        of      value file file-ref

Argument definitions

file-ref

The vfs.file object for which you want the directory name.

You can use vfs.file-directory to create a vfs.directory object representing the file managed by a vfs.file object. This functionality is chiefly useful when dealing with network resources accessed via a protocol such as HTTP or FTP. These protocols will be supported in a later version of the OMVFS library.

The following program opens a file using a vfs.file object and then uses vfs.file-directory to create a vfs.directory object for the directory that contains the file. It then prints the name of the directory using vfs.directory-name.

  import "omvfs.xmd" prefixed by vfs.
  
  process
     local vfs.file foo
     local vfs.directory dir
  
     set foo to vfs.open "file:/c:/temp/bar/bar.txt"
     set dir to vfs.file-directory of foo
     output vfs.directory-name on dir

Exceptions

The following exceptions may occur:

• VFS003 vfsDir objects cannot be created for local paths
• VFS200 The vfsFile object must be opened before it can be used
• VFS300 Generic operating system error

Related Syntax    vfs.directory-name    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 ]