vfsDirName

function

Library: File system utilities (OMVFS legacy)
Include: omvfs.xin

Returns: the current directory for the specified vfsDir object or the local file system

Declaration

define external stream function vfsDirName

or

define external stream function vfsDirName
    on value    vfsDir dir

Argument definitions

dir: is a vfsDir object created by connecting to a directory using either vfsConnect or vfsConnectDir.

Purpose

Use vfsDirName to return the name of:

the current working directory for the local file system format (dir not supplied), or
the current working directory for the specified vfsDir object in URL format (dir supplied)

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omvfs.xin"

The vfsDir object dir must:

represent an existing connection made using vfsConnect or vfsConnectDir (else external exception VFS100)
represent a connection made using the File scheme (else external exception VFS001)

Usage Notes

General OS operation failure exceptions will return external exception VFS300. The accompanying text will contain details on the reason for the exception.

Example:

Obtaining the URLs for a connected vfsDir object and the current working directory on the local file sytem.

  include "omvfs.xin"
  
  process
    local stream myDir
    local stream CWD
       . . .
    set Helsinki to vfsConnect "file:///c:/Formats/Style/"
       . . .
    set myDir to vfsDirName on Helsinki
    set CWD to vfsDirName

Other Library Functions