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

RemoveFile_Multiple

Header:	STD.h
Namespace:	fil
Module:	FoundationLite

Removes files that match a pattern from a directory.

Syntax

void fil::RemoveFile_Multiple
(
	const ftl::Directory& inStartDirectory,
	const ftl::String& inMask,
	bool inProcessSubdirectories,
	bool& outSuccess
)

Parameters

Name	Type	Description
inStartDirectory	const Directory&	Path to the directory from which the files are to be deleted
inMask	const String&	Wildcard pattern
inProcessSubdirectories	bool	Process subdirectories recursively
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
DomainError	inMask needs to be filled in
DomainError	inStartDirectory needs to be filled in