swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
      Other Library Functions  
function  

vfsRead

 
 

Library: File system utilities (OMVFS) legacy
Include: omvfs.xin
Return type: String source

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:

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
   vfsChangeDir
   vfsChangeOwner
   vfsChangePermissions
   vfsClose
   vfsConnect
   vfsConnectDir
   vfsCopy
   vfsCursorPosition
   vfsDeleteDir
   vfsDeleteFile
   vfsDescribe
   vfsDescribeFile
   vfsDir
   vfsDirName
   vfsDisconnect
   vfsFile
   vfsFileDir
   vfsFileName
   vfsIsVersionCompatible
   vfsLibraryVersion
   vfsLink
   vfsList
   vfsLock
   vfsMakeDir
   vfsMove
   vfsMoveCursor
   vfsOpen
   vfsRead
   vfsRename
   vfsTruncate
   vfsUnlock
   vfsWrite
 
 

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

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.