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

vfsClose

 
 

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

Declaration

define function vfsClose
 value vfsFile  file

Argument definitions

file
is the vfsFile object to be discarded.


Purpose

Use vfsClose to declare explicitly that the specified vfsFile object is no longer needed.

Requirements

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

  include "omvfs.xin"

Usage Notes

Discarding an unopened vfsFile is allowed.

Discarding a previously discarded vfsFile is allowed.

General OS operation failure exceptions will return external exception VFS300. The text accompanying the exception will contain details on the reason for the exception.

Example

Discarding a vfsFile

  include "omvfs.xin"
  
  process
    local vfsFile myFile
  	. . .
    set myFile to vfsOpen "foo.txt"
  	. . .
    vfsClose 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.