Back to FabImage Library Lite website
You are here: Start » System » File System » RemoveFile_Single

RemoveFile_Single
Header: | STD.h |
---|---|
Namespace: | fil |
Removes single file.
Syntax
void fil::RemoveFile_Single ( const ftl::File& inFile, bool& outSuccess )
Parameters
Remarks
inMask pattern string
Port inMask specifies wildcard pattern that selects files this filter will operate on. Supported wildcards:- * - any string of characters, including no characters
- ? - exactly one character
Examples:
- * - all files,
- *.jpg - files only with extension .jpg,
- Filename.* - files with name "Filename" and any extension, including no extension e.g. "Filename."
- Filename.?? - files with name "Filename" and two letter extension,
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | inFile does not exist in RemoveFile. |
DomainError | inFile is not a normal file in RemoveFile. |
See Also
- FindFiles – Returns files of the input directory.