remove()

void xtd::io::file_info::remove ( ) const

overridevirtual

Permanently deletes a file.

Exceptions

xtd::io::io_exception	The target file is open or memory-mapped on a computer running Microsoft Windows NT. -or- There is an open handle on the file, and the operating system is Windows XP or earlier. This open handle can result from enumerating directories and files. For more information, see How to: Enumerate Directories and Files.
xtd::security::security_exception	The caller does not have the required permission.
xtd::unauthorized_access_exception	The path is a directory.

Examples

The following example demonstrates the xtd::io::file_info::remove method.

#include <xtd/xtd>
 
using namespace xtd;
using namespace xtd::io;
 
class program {
public:
  static auto main() {
    string path = R"(c:\MyTest.txt)";
    file_info fi1(path);
 
    try {
      block_scope_(ofstream ofs = fi1.create_text()) {}
      string path2 = path + "temp";
      file_info fi2(path2);
 
      //Ensure that the target does not exist.
      fi2.remove();
 
      //Copy the file.
      fi1.copy_to(path2);
      console::write_line("{0} was copied to {1}.", path, path2);
 
      //Delete the newly created file.
      fi2.remove();
      console::write_line("{0} was successfully deleted.", path2);
    } catch (const exception& e) {
      console::write_line("The process failed: {0}", e.to_string());
    }
  }
};
 
startup_(program::main);
 
// This code produces output similar to the following;
// results may vary based on the computer/file structure/etc.:
//
//c:\MyTest.txt was copied to c:\MyTest.txttemp.
//c:\MyTest.txttemp was successfully deleted.

Examples

The following example creates, closes, and deletes a file.

#include <xtd/xtd>
 
using namespace xtd::io;
 
class program {
public:
  static auto main() {
    // Create a reference to a file.
    file_info fi("temp.txt");
    // Actually create the file.
    std::ofstream ofs = fi.create();
    // Modify the file as required, and then close the file.
    ofs.close();
    // Delete the file.
    fi.remove();
  }
};
 
startup_(program::main);

Remarks

If the file does not exist, this method does nothing.

Implements xtd::io::file_system_info.

Examples

file_info.cpp.