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

Return type: String Returns:  The fully qualified file name in URL or local file system format.

Declaration

  define external stream function vfsFileName
         value  vfsFile  file

Argument definitions

file

is the vfsFile component associated with the file you want to obtain the name of.

Use vfsFileName to get the file name of a vfsFile object.

Requirements

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

  include "omvfs.xin"

The vfsFile object file must be open (else external exception VFS200).

Usage Notes

The function returns the filename in

• URL format if the file was opened using an URL, or
• local file system format if the file was opened using a local path

Example: Get the name of the file associated with a specific vfsFile variable.

The output from this program will be "/programs/myscript.xom".

  include "omvfs.xin"

  process
    local vfsFile myFile
    local stream file-name
  	. . .
    set myFile to vfsOpen "/programs/myscript.xom"
    	. . .
    set file-name to vfsFileName myFile
    output file-name

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

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]