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

FindFiles

Returns files of the input directory.

Syntax

void avl::FindFiles
(
	const atl::Directory& inStartDirectory,
	const atl::String& inMask,
	bool inSubdirs,
	atl::Array<atl::File>& outFilePaths,
	atl::Array<atl::String>& outFileNames
)

Parameters

Name	Type	Default	Description
inStartDirectory	const Directory&	\".\"	Input directory
inMask	const String&	\"*\"	Regular expression
inSubdirs	bool		Read subdirectories
outFilePaths	Array<File>&		File paths
outFileNames	Array<String>&		File names

Remarks

Working with Find Files

Start with defining a directory path in inStartDirectory port to choose where you want to look for files. To search files in subdirectories set inSubdirs to 'true'. Port inMask filters search results, you can use any expression like examples below:

Examples:

* - finds all files,
*.jpg - finds files only with extension .jpg,
Adaptive.* - finds files with name "Adaptive"

Errors

Error type	Description
DomainError	Given start directory is invalid in FindFiles.
IoError	Error opening start directory in FindFiles.