swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

vfsDirName

 
 

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

Returns: The function 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:

Requirements

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

  include "omvfs.xin"

The vfsDir object dir must:

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
   vfsChangeDir
   vfsChangeOwner
   vfsChangePermissions
   vfsClose
   vfsConnect
   vfsConnectDir
   vfsCopy
   vfsCursorPosition
   vfsDeleteDir
   vfsDeleteFile
   vfsDescribe
   vfsDescribeFile
   vfsDir
   vfsDirName
   vfsDisconnect
   vfsFile
   vfsFileDir
   vfsFileName
   vfsIsVersionCompatible
   vfsLibraryVersion
   vfsLink
   vfsList
   vfsLock
   vfsMakeDir
   vfsMove
   vfsMoveCursor
   vfsOpen
   vfsRead
   vfsRename
   vfsTruncate
   vfsUnlock
   vfsWrite
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.