Start » Filter Reference » System » File System » RemoveFile_Multiple
Module: | FoundationLite |
---|
Removes files that match a pattern from a directory.
Name | Type | Description | |
---|---|---|---|
inStartDirectory | Directory | ||
inMask | String | Wildcard pattern | |
inProcessSubdirectories | Bool | ||
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
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 | inMask needs to be filled in |
DomainError | inStartDirectory needs to be filled in |
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.