vfsRead

function

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

Returns: an OmniMark source object to the opened file

Declaration

define external string source function vfsRead
     value  vfsFile  file

Argument definitions

file: is the vfsFile object associated with the file to be read from.

Purpose

Use vfsRead to read the contents of a vfsFile and return them in an OmniMark source.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omvfs.xin"

The vfsFile object file must:

be open (else external exception VFS200)
have been opened with read access (else external exception VFS207)
not be currently read from or written to (else external exception VFS204)

No other process can have an exclusive (write) lock on the entire file or any part of it that you attempt to read (external exception VFS217).

Usage Notes

The locking exception can be thrown at any point while reading the file (external exception VFS217).

External exception VFS300 is thrown for any general OS operation failure. The text accompanying the exception will contain details on the reason for the failure.

Example

Read the file myscript.xom

  include "omvfs.xin"
  
  process
    local vfsFile myFile
  	. . .
     set myFile to vfsOpen "/programs/myscript.xom" 
    	for VFS-READ
  	output vfsRead myFile

Other Library Functions