Back to Aurora Vision Library Lite website
You are here: Start » System » File System » RemoveFile_Single
RemoveFile_Single
| Header: | STD.h |
|---|---|
| Namespace: | avl |
Removes single file.
Syntax
C++
Python
void avl::RemoveFile_Single ( const atl::File& inFile, bool& outSuccess )
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
![]() |
inFile | const File& | Path to the file to delete | |
![]() |
outSuccess | bool& | Whether the deletion was successful or not |
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,
Warning:All tools applied to a specific device or file should be managed within a single thread to ensure centralized tracking, traceability, and consistency throughout the process.
Errors
List of possible exceptions:
| Error type | Description |
|---|---|
| IoError | inFile does not exist in RemoveFile. |
| IoError | inFile is not a normal file in RemoveFile. |
See Also
- FindFiles – Returns files of the input directory.


