Start » Filter Reference » System » File System » RemoveFile_Single

RemoveFile_Single

Advanced

Module: FoundationLite

Removes single file.

Name Type Description
Input value
 inFile File
Output value
 outSuccess Bool

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

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError inFile does not exist in RemoveFile.
DomainError inFile is not a normal file in RemoveFile.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of RemoveFile filter group.

See Also

  • FindFiles – Returns files of the input directory.