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

vfsDeleteFile

 
 

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

Declaration

define external function vfsDeleteFile
       value    stream   path
     
or
     
define external function vfsDeleteFile
       value    stream   filename-URL
   on  value    vfsDir   dir

Argument definitions

path
is the path for the file to be deleted expressed in local file system format.
filename-URL
is the name of the file to be deleted expressed as a relative URL using the specified vfsDir object as its base.
dir
is a vfsDir object created using either vfsConnect or vfsConnectDir.


Purpose

Use vfsDeleteFile to remove an existing file from the virtual file system.

Requirements

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

  include "omvfs.xin"

path must:

filename-URL must:

The vfsDir object dir must:

Usage Notes

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.

External exception VFS111 is thrown if an URL supplied as a parameter to this function contains invalid encoding. (See Internet Standards RFC 1738: Uniform Resource Locators for details on valid encoding.)

External exception VFS004 is thrown if the URL exceeds system length limits.

For complete details on relative URLs, see Internet Standards RFC 1808: Relative Uniform Resource Locators.

Example

Deleting a file from the current directory

  include "omvfs.xin"
  
  
  process
    vfsDeleteFile "myfile.txt" 

      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.