delete_filedelete_fileDeleteFileDeleteFiledelete_file (Operator)
Name
delete_filedelete_fileDeleteFileDeleteFiledelete_file — Delete a file.
Signature
Herror delete_file(const char* FileName)
Herror T_delete_file(const Htuple FileName)
Description
delete_filedelete_fileDeleteFileDeleteFileDeleteFiledelete_file deletes the file given by FileNameFileNameFileNameFileNamefileNamefile_name.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
File to be deleted.
Result
delete_filedelete_fileDeleteFileDeleteFileDeleteFiledelete_file returns the value 2 (
H_MSG_TRUE)
if the file exists and
could be deleted. Otherwise, an exception is raised.
Module
Foundation