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

EnumerateObjects

Header:	STD.h
Namespace:	fil
Module:	FoundationLite

Enumerates the fidata files present in a disk directory and sorts them according to the specified order and loads an object from a file.

Syntax

bool fil::EnumerateObjects
(
	EnumerateFilesState& ioState,
	const ftl::Directory& inDirectory,
	fil::FileSortingOrder::Type inSortingOrder,
	bool inRepeat,
	bool inProcessSubdirectories,
	bool inInvert,
	fil::StreamMode::Type inStreamMode,
	ftl::File& outFilePath,
	ftl::String& outFileName,
	Type& outObject,
	ftl::Optional<bool> outIsFirst = ftl::NIL,
	ftl::Optional<bool> outIsLast = ftl::NIL
)

Parameters

Name	Type	Default	Description
ioState	EnumerateFilesState&		Object used to maintain state of the function.
inDirectory	const Directory&		Input directory
inSortingOrder	FileSortingOrder::Type		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
inStreamMode	StreamMode::Type		Binary or text format of the files.
outFilePath	File&		Output file path
outFileName	String&		Output file name
outObject	Type&
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 ftl::NIL to these parameters: outIsFirst, outIsLast.

Remarks

Linux

Sorting output by file creation date when running FIL on Linux is not possible due to file system restrictions. When requested to do so EnumerateFiles will throw an exception.

Errors

List of possible exceptions:

Error type	Description
DomainError	Not supported stream mode in EnumerateObjects function.