vfsMakeDir

function

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:

not already exist (else external exception VFS307)
be expressed in local file system format

new-URL must:

not already exist (else external exception VFS307)
be expressed as a relative URL with the vfsDir object dir as its base

The vfsDir object dir must:

represent an existing connection made using vfsConnect or vfsConnectDir (else external exception VFS100)
represent a connection made using the File scheme (else external exception VFS001)

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