dirRemove

dirRemove

Removes a directory.

Method of

File object

Syntax

int dirRemove( FileSpecObject dirToRemove [, boolean recursive] );

Parameters

The dirRemove method has the following parameters:

dirToRemove
A FileSpecObject representing the directory to be removed.
recursive
An optional boolean value indicating whether the remove operation is to be performed recursively (1) or not (0).

Returns

An integer error code. For a list of possible values, see Return Codes.

Document Tags and Contributors

Contributors to this page: Sheppy, Fredchat, trevorh, Rod Whiteley
Last updated by: Sheppy,