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

vfs.open-file-system

 
 

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

Returns: A VFS file object for the opened file.


Declaration

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

Argument definitions

filename
The 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-file-system to open a file. vfs.open-file-system 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:

This function is identical to vfs.open except that non-file URLs are not supported.

Exceptions

The following exceptions may occur:

        Other Library Functions
   vfs.change-directory
   vfs.change-owner
   vfs.change-permissions
   vfs.close
   vfs.connect
   vfs.connect-directory
   vfs.copy
   vfs.cursor-position
   vfs.default-certificates-file
   vfs.delete-directory
   vfs.delete-file
   vfs.describe
   vfs.describe-file
   vfs.directory
   vfs.directory-name
   vfs.disconnect
   vfs.file
   vfs.file-directory
   vfs.file-name
   vfs.link
   vfs.list
   vfs.lock
   vfs.make-directory
   vfs.move
   vfs.move-cursor
   vfs.omvfs-version
   vfs.open
   vfs.open-file-system
   vfs.open-ftp
   vfs.open-http
   vfs.open-https
   vfs.reader
   vfs.set-default-certificates-file
   vfs.truncate
   vfs.unlock
   vfs.writer
 
 

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.