Back to Aurora Vision Library Lite website
You are here: Start » System » File System » EnumerateFiles_Random
EnumerateFiles_Random
Header: | STD.h |
---|---|
Namespace: | avl |
Enumerates the files present in a disk directory sorted randomly.
Syntax
bool avl::EnumerateFiles_Random ( EnumerateFilesState& ioState, const atl::Directory& inDirectory, const atl::String& inExtensions, atl::Optional<int> inSeed, bool inRepeat, bool inProcessSubdirectories, bool inInvert, atl::File& outFilePath, atl::String& outFileName, atl::Optional<bool> outIsFirst = atl::NIL, atl::Optional<bool> outIsLast = atl::NIL )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
ioState | EnumerateFilesState& | Object used to maintain state of the function. | ||
inDirectory | const Directory& | Input directory | ||
inExtensions | const String& | Allowed extensions separated by semicolon | ||
inSeed | Optional<int> | Random seed used to determine random sorting order | ||
inRepeat | bool | Determines whether to repeat reading directory after reading all files | ||
inProcessSubdirectories | bool | Flag indicating whether to enumerate files from the subdirectories or not | ||
inInvert | bool | Flag indicating whether to enumerate files backwards or not | ||
outFilePath | File& | Output file path | ||
outFileName | String& | Output file name | ||
outIsFirst | Optional<bool> | NIL | Flag indicating the first iteration | |
outIsLast | Optional<bool> | NIL | Flag indicating the last iteration |
Optional Outputs
The computation of following outputs can be switched off by passing value atl::NIL
to these parameters: outIsFirst, outIsLast.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Cannot sort by file creation date on Linux. |
DomainError | Directory doesn't exist: Directory path |
DomainError | Empty string is not a valid directory path. |