Back to FabImage Library website
You are here: Start » Function Reference » System » File System » FindFiles
Header: | STD.h |
---|---|
Namespace: | fil |
Module: | FoundationLite |
Returns files of the input directory.
Syntax
void fil::FindFiles ( const ftl::Directory& inStartDirectory, const ftl::String& inMask, bool inSubdirs, ftl::Optional<fil::FileSortingOrder::Type> inSortingOrder, ftl::Array<ftl::File>& outFilePaths, ftl::Array<ftl::String>& outFileNames, bool& outFound = ftl::Dummy<bool>() )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
![]() |
inStartDirectory | const Directory& | \".\" | Input directory |
![]() |
inMask | const String& | \"*\" | Wildcard pattern |
![]() |
inSubdirs | bool | Read subdirectories | |
![]() |
inSortingOrder | Optional<FileSortingOrder::Type> | NIL | Sorting order |
![]() |
outFilePaths | Array<File>& | File paths | |
![]() |
outFileNames | Array<String>& | File names | |
![]() |
outFound | bool& | Dummy<bool>() |
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'.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
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Given start directory is invalid in FindFiles. |
IoError | Error opening start directory in FindFiles. |
See Also
- TestFileExists – Checks if a given file is present.