vfs.describe-file

function

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

Declaration

export external function describe-file
                value      file   file-ref
        into    write-only string attributes

Argument definitions

file-ref: The vfs.file object to query.

attributes: A string or stream shelf of variable size into which the attributes will be written.

Purpose

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 string 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 Topics