You are here: Start » FIL.NET » Function Reference » Image » Image IO » FIL.GrabImage_FromFiles

FIL.GrabImage_FromFiles

Simulates capturing a frame from a camera.

Namespace:FilNet
Assembly:FIL.NET.dll

Syntax

C++
C#
 
public static bool GrabImage_FromFiles
(
	string inDirectory,
	FilNet.ImageFileFormat? inFileType,
	FilNet.FileSortingOrder inSortingOrder,
	bool inRepeat,
	bool inProcessSubdirectories,
	bool inInvert,
	bool inLoadAlphaChannel,
	FilNet.Image outImage,
	out string outFilePath,
	out string outFileName
)

Parameters

Name Type Range Default Description
inDirectorystring\".\"Input directory. Default value: ".".
inFileTypeFilNet.ImageFileFormat?File format of the images. Default value: ftl::NIL.
inSortingOrderFilNet.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.
outImageFilNet.ImageOutput image.
outFilePathstringOutput file path.
outFileNamestringOutput file name.

Description

This filter works similarly to EnumerateImages, but it behaves more like a camera: it preserves its state across the whole program.

For example, you can have two GrabImage_FromFiles filters in two different Task macrofilters. When execution of second Task starts, images loaded previously in the first Task are not loaded again.

Function Overrides

See also