vfsFile

data type

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

Purpose

The vfsFile OMX component represents an individual file.

Usage Notes

The OmniMark Virtual File System dynamic link library file ("omvfs.dll") creates the vfsFile OMX component. The related include file ("omvfs.xin") defines the interface to that component. To use vfsFile OMX components in your program, you must include the following include statement in your program:

     include "omvfs.xin"

Please refer to OMX Components for a general description of OMX components and how they are used.

Related OMVFS library functions:

The functions

vfsOpen - open a file.
vfsClose - close a file.

are used to open and close files. vfsFile objects are used by the following OMVFS library functions:

vfsCursorPosition - get the current position of the cursor in a vfsFile object.
vfsDescribeFile - return a set of attributes describing a file.
vfsFileDir - get the directory location of the file.
vfsFileName - get the file name of a vfsFile object.
vfsLock - lock an entire vfsFile object or a specific area of it.
vfsMoveCursor - change the cursor position from the current location in a file's contents to the position you specify.
vfsRead - read the contents of a vfsFile and return them in an OmniMark source.
vfsTruncate - truncate a file at a specified byte.
vfsUnlock - unlock a single locked section or an entire file.
vfsWrite - obtain an output object (write) to an open file.

Example: Opening a file

  include "omvfs.xin"
  process
    local vfsFile myFile
    local vfsDir myDir
    local stream attributes-shelf variable
    set myDir to vfsConnect "file:///omprogs/"
    set myFile to vfsOpen "jean-sibelius.txt" on myDir for vfs-read 
    vfsDescribeFile myFile into attributes-shelf
    output "    Name:   " || attributes-shelf{"name"} || "%n"
    output "    Size:   " || attributes-shelf{"size"} || " bytes%n"
    do when attributes-shelf{"isdir"} = 0
      output "    Type:   file" || "%n"
    else
      output "    Type:   directory" || "%n"
    done
    output "Contents:  " || vfsRead myFile || "%n"

This program produces the following output:

  Name:   file:///omprogs/jean-sibelius.txt
      Size:   115 bytes
      Type:   file
  Contents:  "Pay no attention to what the critics say; no statue has ever been erected to a critic."
       -- Jean Sibelius

Other Library Functions