Back to FabImage Library website

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

FindDirectories


Header: STD.h
Namespace: fil
Module: FoundationLite

Returns subdirectories of the input directory.

Syntax

void fil::FindDirectories
(
	const ftl::Directory& inStartDirectory,
	bool inRecursive,
	ftl::Optional<fil::FileSortingOrder::Type> inSortingOrder,
	ftl::Array<ftl::Directory>& outDirectories,
	bool& outFound = ftl::Dummy<bool>()
)

Parameters

Name Type Default Description
Input value
 inStartDirectory const Directory& \".\"
Input value
 inRecursive bool
Input value
 inSortingOrder Optional<FileSortingOrder::Type> NIL Sorting order
Output value
 outDirectories Array<Directory>&
Output value
 outFound bool& Dummy<bool>()

Errors

List of possible exceptions:

Error type Description
DomainError Given start directory is invalid in FindDirectories.