Back to FabImage Library website

You are here: Start » Function Reference » System » File System » RemoveFile_Single

RemoveFile_Single


Header: STD.h
Namespace: fil
Module: FoundationLite

Removes single file.

Syntax

void fil::RemoveFile_Single
(
	const ftl::File& inFile,
	bool& outSuccess
)

Parameters

Name Type Default Description
Input value inFile const File& Path to the file to delete
Output value 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
You can use any expression like examples below:
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
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.