remove() [2/2]

void xtd::io::directory_info::remove

(

bool

recursive

)

const

Deletes this instance of a DirectoryInfo, specifying whether to delete subdirectories and files.

Parameters

recursive

true to delete this directory, its subdirectories, and all files; otherwise, false.

Exceptions

xtd::unauthorized_access_exception	The directory contains a read-only file.
xtd::io::directory_not_found_exception	The directory described by this xtd::io::directory_info object does not exist or could not be found.
xtd::io::io_exception	The directory is not empty. -or- The directory is the application's current working directory. -or- There is an open handle on the directory.
xtd::security::security_exception	The caller does not have the required permission.

Examples

The following example demonstrates deleting a directory. Because the directory is removed, first comment out the Delete line to test that the directory exists. Then uncomment the same line of code to test that the directory was removed successfully.

#include <xtd/xtd>
 
using namespace xtd;
using namespace xtd::io;
 
class program {
public:
  static auto main() {
    // Make a reference to a directory.
    directory_info di("TempDir");
 
    // Create the directory only if it does not already exist.
    if (di.exists() == false)
      di.create();
 
    // Create a subdirectory in the directory just created.
    directory_info dis = di.create_subdirectory("SubDir");
 
    // Process that directory as required.
    // ...
 
    // Delete the subdirectory. The true indicates that if subdirectories
    // or files are in this directory, they are to be deleted as well.
    dis.remove(true);
 
    // Delete the directory.
    di.remove(true);
  }
};
 
startup_(program::main);

Remarks

If the xtd::io::directory_info has no files or subdirectories, this method deletes the xtd::io::directory_info even if recursive is false. Attempting to delete a xtd::io::directory_info that is not empty when recursive is false throws an xtd::io::io_exception.

For a list of common I/O tasks, see Common I/O Tasks.