vfs.file-name

function

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

Returns: the fully qualified file name

Declaration

export external stream function file-name
        of      value file file-ref

Argument definitions

file: The vfs.file component associated with the file you want to obtain the name of.

Purpose

You can use vfs.file-name to get the file name of a vfs.file object.

  import "omvfs.xmd" prefixed by vfs.
  
  process
    local vfs.file myFile
    set myFile to vfs.open "/programs/myscript.xom"
    output vfs.file-name of myFile

The function returns the filename in URL format if the file was opened using an URL, or in the local file system format if the file was opened using a local path.

Exceptions

The following exceptions may occur:

VFS200 The vfsFile object must be opened before it can be used

Related Topics

vfs.open
vfs.file