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

Return type: String Returns: The function returns the current directory for the specified VFS directory object or the local file system.

Declaration

export external stream function directory-name
        on      value directory on-dir optional

Argument definitions

on-dir

A connected vfs.directory object.

You can use vfs.directory name to return the current working directory:

The following program saves the current working directory, changes directories, performs an operation, and restores the current working directory:

  import "omvfs.xmd" prefixed by vfs.
  
  process
     local stream cwd initial {vfs.directory-name}
     local stream listing variable
     vfs.change-directory "c:\foo\bar"
     vfs.list into listing
     repeat over listing
        output listing || "%n"
     again
     vfs.change-directory cwd

If you specify a vfs.directory, then the function returns the name of the directory represented by the vfs.directory object. The directory name is returned in URL format.

  import "omvfs.xmd" prefixed by vfs.
  
  process
     local stream listing variable
     local vfs.directory dir
     set dir to vfs.connect-directory "file:/c:/foo/bar"
     output vfs.directory-name on dir || "%n"
     vfs.change-directory ".." on dir
     output vfs.directory-name on dir

Exceptions

The following exceptions may occur:

• VFS001 The requested function is not supported for the type of connection
• VFS100 The vfsDir object must be connected before it can be used
• VFS300 Generic operating system error

Related Syntax    vfs.connect    vfs.connect-directory    vfs.make-directory    vfs.delete-directory    vfs.change-directory    vfs.file-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 ] [ LEGACY LIBRARIES ] [ ERRORS ]