swirl
Guide to OmniMark 9   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Topics   Other Library Functions  
function  

vfs.open

 
 

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

Returns: A VFS file object for the opened file.


Declaration

export external file function open
                value string filename
        on      value directory on-dir optional
        for     value integer access-type optional initial {read-mode}

Argument definitions

filename
The path (which may be either an URL or a local file system path) to the file to be opened.
on-dir
A connected vfs.directory object. If this parameter is specified the filename parameter is interpreted relative to the vfs.directory and must be expressed as a relative URL.
access-type
An integer constant signifying the desired mode of access. The default value is vfs.read-mode.


Purpose

You can use vfs.open to open a file. vfs.open creates a vfs.file object that represents the file, and which can be used with various OMVFS functions to manipulate the file.

You may specify the mode in which the file is opened. The default mode is read mode. The following modes are available:

Exceptions

The following exceptions may occur:

    Related Topics
 
Other Library Functions
 
 

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

OmniMark 9.1.0 Documentation Generated: September 2, 2010 at 1:38:10 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2010.