[<<Previous Entry] [^^Up^^] [Next Entry>>] [Menu] [About The Guide]
 _fsRmDir()
 Remove a directory
------------------------------------------------------------------------------
 C Prototype

     #include "filesys.api"
     BOOL _fsRmDir(
                       BYTEP fpDirName
                     )

 Arguments

     fpDirName is the name of the directory to remove, including an
     optional drive.  If you do not specify a drive, the current one is used.

 Returns

     _fsRmDir() returns TRUE if successful; otherwise, FALSE.

 Description

     This function removes a specified directory.  You must have sufficient
     rights to delete a directory.  A directory must be empty in order to be
     deleted.  Therefore, to delete a directory that contains subdirectories,
     you must first delete the subdirectories.  This function is equivalent
     to the CA-Clipper function DIRREMOVE().  If an error occurs, _fsError()
     will return the number of the error.

 Examples

     .  The following code fragment illustrates the use of _fsRmDir():

        #include "filesys.api"
        .
        .
        .
        if (! _fsRmDir( "c:\test\one" ) )
        {
           // Report the error condition using _fsError()
        }

 Files  Library is CLIPPER.LIB, header file is Filesys.api.


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