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

Declaration

  export external function describe-file
                  value file file-ref
          into    modifiable stream attributes

Argument definitions

file-ref

The vfs.file object to query.

attributes

A variable stream shelf into which the attributes will be written.

You can use vfs.describe-file to access the attributes of a file that has been opened using vfs.open. vfs.describe-file behaves the same way as vfs.describe except that:

• You specify the file to be described using a vfs.file object rather than a path.
• vfs.describe-file can only be used with files, not directories.

The following program outputs a description of a file. See vfs.describe for details.

  import "omvfs.xmd" prefixed by vfs.

  process
     local stream attr variable
     local vfs.file bar-file
     set bar-file to vfs.open "c:\foo\bar\bar.txt"
     vfs.describe-file bar-file into attr

     repeat over attr
        output key of attr || ": " || attr || "%n"
     again

     output "User write permission: "
     do when attr{"permissions"} mask vfs.permit-user-write > 0
        output "yes%n"
     else
        output "no%n"
     done   

Exceptions

The following exceptions may occur:

• VFS200 The vfsFile object must be opened before it can be used
• VFS300 Generic operating system error

Related Syntax    vfs.describe    vfs.file-name    vfs.file-directory    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 ] [ LEGACYLIBRARIES ] [ ERRORS ]