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

vfsFileDir

 
 

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

Returns: The vfsDir connected to the location containing file if file was opened using an URL.


Declaration

define external vfsDir function
   vfsFileDir value vfsFile file

Argument definitions

file
is the vfsFile you want the directory location for.


Purpose

Use vfsFileDir to get the directory location of the file. The function returns a vfsDir object.

Requirements

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

  include "omvfs.xin"

file 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: Find the vfsDir for the directory where myFile is located.

The output for this program will be "file:///programs/".

  include "omvfs.xin"
  
  process
    local vfsFile myFile
    local vfsDir my-dir
  	. . .
    set myFile to vfsOpen "file:///programs/myscript.xom" 
  	. . .
    set my-dir to vfsFileDir myFile
  	. . .
    output vfsDirName my-dir

        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.