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

vfs.delete-file

 
 

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

Declaration

export external function delete-file
                value string filename
        on      value directory on-dir optional

Argument definitions

filename
The path of the file to be deleted.
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.


Purpose

You can use vfs.delete-file to delete a file.

  import "omvfs.xmd" prefixed by vfs.
  process
    vfs.delete-file "c:\temp\myfile.txt"
    vfs.delete-file "hello.xml"

The specified file must exist or exception VFS306 is thrown.

Exceptions

The following exceptions may occur:

    Related Syntax
   vfs.make-directory
   vfs.delete-directory
   vfs.link
   vfs.copy
   vfs.move
   vfs.directory
 
  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.