You are here: Start » FIL.NET » Invoke.EnumerateImages_Random

Invoke.EnumerateImages_Random

Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted randomly.

Namespace:Fil
Assembly:FilNet.dll

Syntax

C++
C#
 
public static bool EnumerateImages_Random
(
	Fil.EnumerateFilesRandomState ioState,
	string inDirectory,
	Optional<Fil.ImageFileFormat> inFileType,
	Optional<int> inSeed,
	bool inRepeat,
	bool inProcessSubdirectories,
	bool inInvert,
	bool inLoadAlphaChannel,
	int inDelay,
	Fil.Image outImage,
	out string outFilePath,
	out string outFileName,
	Optional<bool> outIsFirst,
	Optional<bool> outIsLast
)

Parameters

Name Type Range Default Description
ioStateFil.EnumerateFilesRandomState
inDirectorystring\".\"Input directory. Default value: ".".
inFileTypeFtl.Optional<Fil.ImageFileFormat>File format of the images. Default value: ftl::NIL.
inSeedFtl.Optional<int>Random seed used to determine random sorting order. Default value: ftl::NIL.
inRepeatboolDetermines whether to repeat reading directory after reading all files.
inProcessSubdirectoriesboolFlag indicating whether to load images from the subdirectories or not.
inInvertboolFlag indicating whether to enumerate images backwards or not.
inLoadAlphaChannelboolFlag indicating whether to load alpha channel of the image or not.
inDelayintMinimum time between iterations in milliseconds.
outImageFil.ImageOutput image.
outFilePathstringOutput file path.
outFileNamestringOutput file name.
outIsFirstFtl.Optional<bool>Flag indicating the first iteration.
outIsLastFtl.Optional<bool>Flag indicating the last iteration.

See also