You are here: Start » AVL.NET » AVS.EnumerateImages Method

AVS.EnumerateImages Method

Scans a disk directory for image files and then returns the images one by one in consecutive iterations sorted according to the specified order.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

public static bool EnumerateImages
(
	AvlNet.EnumerateFilesState ioState,
	string inDirectory,
	AvlNet.ImageFileFormat? inFileType,
	AvlNet.FileSortingOrder inSortingOrder,
	bool inRepeat,
	bool inProcessSubdirectories,
	bool inInvert,
	bool inLoadAlphaChannel,
	int inDelay,
	AvlNet.Image outImage,
	out string outFilePath,
	out string outFileName,
	out bool outIsFirst,
	out bool outIsLast
)

Parameters

Name Type Range Default Description
ioStateAvlNet.EnumerateFilesState
inDirectorystring\".\"Input directory. Default value: ".".
inFileTypeAvlNet.ImageFileFormat?File format of the images. Default value: atl::NIL.
inSortingOrderAvlNet.FileSortingOrderSorting order.
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.
outImageAvlNet.ImageOutput image.
outFilePathstringOutput file path.
outFileNamestringOutput file name.
outIsFirstboolFlag indicating the first iteration.
outIsLastboolFlag indicating the last iteration.

Function Overrides

See also