delete_filedelete_fileDeleteFileDeleteFile (Operator)
Name
delete_filedelete_fileDeleteFileDeleteFile — Delete a file.
Signature
Herror delete_file(const char* FileName)
Herror T_delete_file(const Htuple FileName)
Description
delete_filedelete_fileDeleteFileDeleteFileDeleteFile deletes the file given by FileNameFileNameFileNameFileNamefileName.
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
FileNameFileNameFileNameFileNamefileName (input_control) filename → HTupleHTupleHtuple (string) (string) (HString) (char*)
File to be deleted.
Result
delete_filedelete_fileDeleteFileDeleteFileDeleteFile returns the value 2 (H_MSG_TRUE) if the file exists and
could be deleted. Otherwise, an exception is raised.
Module
Foundation