vfsDisconnect

function

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

Declaration
define function vfsDisconnect
     value  vfsDir     dir

Argument definitions

dir
is the vfsDir object to be discarded


Purpose

Use vfsdisconnect to discard a directory connection that is no longer needed. This allows the system to release un-needed resources.

Requirements

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

  include "omvfs.xin"

Usage Notes

You are allowed to discard an unconnected vfsDir.

You are allowed to discard a previously discarded vfsDir.

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

Discarding a connection

  include "omvfs.xin"
  
  process
    local vfsDir Chicago
     	. . .
    set Chicago to vfsConnect "file:///myPrograms/"
  	. . .
    vfsDisconnect Chicago