[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 DIRREMOVE()
 Removes a directory
------------------------------------------------------------------------------
 Syntax

     DIRREMOVE(<cDirectory>) --> nErrorCode

 Argument

     <cDirectory>  Designates which directory name to remove.

 Returns

     DIRREMOVE() returns a 0 when the designated directory is successfully
     removed; otherwise, an error code is returned.  The codes are defined as
     follows:

     Table 7-4:  DIRREMOVE() Error Code
     ------------------------------------------------------------------------
     Code    Definition
     ------------------------------------------------------------------------
      0      Directory has been successfully removed.
     -3      Access path not found or directory not empty.
     -5      Access denied (e.g., in a network)
     -16     Current directory (cannot be removed)
     ------------------------------------------------------------------------

 Description

     DIRREMOVE() removes a designated directory.  This frees up the memory
     disk that an empty subdirectory occupies.

 Notes

     .  Use a drive designator and access path with <cDirectory>,
        wildcards are not permitted.

     .  The directory must be empty before you can remove it.

 Examples

     Remove the "\DATA" directory:

     IF DIRREMOVE("\DATA") == 0
        ? "Directory deleted."
     ENDIF


See Also: DIRCHANGE() DIRMAKE() DIRNAME()
This page created by ng2html v1.05, the Norton guide to HTML conversion utility. Written by Dave Pearson