vfsClose

function

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