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

vfsMakeDir

 
 

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

Declaration

define external function vfsMakeDir
       value  stream  new-path

or

define external function vfsMakeDir
       value  stream  new-URL
   on  value  vfsDir  dir

Argument definitions

new-path
is the directory to be created expressed in local file system format.
new-URL
is the directory to be created expressed a relative URL using the File scheme and with the specified vfsDir object as its base.
dir
is a vfsDir object created by connecting to a directory using either vfsConnect or vfsConnectDir.


Purpose

Use vfsMakeDir to create a new subdirectory under an existing directory on your local file system.

Requirements

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

  include "omvfs.xin"

new-path must:

new-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.

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

For complete details on absolute URLs and valid encoding, see Internet Standards RFC 1738: Uniform Resource Locators.

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

Example

Adding a subdirectory called PhreddiesStuff to an existing directory using an absolute path.

  include "omvfs.xin"
  
  process
    vfsMakeDir "/Program Files/OmniMark/PhreddiesStuff"

        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.