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

Return type: String 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.

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

Other Library Functions vfs.change-directory vfs.change-owner vfs.change-permissions vfs.close vfs.connect vfs.connect-directory vfs.copy vfs.cursor-position vfs.default-certificates-file vfs.delete-directory vfs.delete-file vfs.describe vfs.describe-file vfs.directory vfs.directory-name vfs.disconnect vfs.file vfs.file-directory vfs.file-name vfs.link vfs.list vfs.lock vfs.make-directory vfs.move vfs.move-cursor vfs.omvfs-version vfs.open vfs.open-file-system vfs.open-ftp vfs.open-http vfs.open-https vfs.reader vfs.set-default-certificates-file vfs.truncate vfs.unlock vfs.writer

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