Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Array Basics » FisFilter_GetArrayElements_Deprecated

FisFilter_GetArrayElements_Deprecated


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: STD.h
Namespace: fis
Module: FoundationLite

Extracts up to 8 individual elements from an array.

Syntax

void fis::FisFilter_GetArrayElements_Deprecated
(
	const ftl::Array<Type>& inArray,
	const int inStart,
	const int inCount,
	bool inInverse,
	Type& outValue1,
	Type& outValue2,
	Type& outValue3,
	Type& outValue4,
	Type& outValue5,
	Type& outValue6,
	Type& outValue7,
	Type& outValue8
)

Parameters

Name Type Range Default Description
Input value inArray const Array<Type>& Input array
Input value inStart const int 0 - First element index
Input value inCount const int 1 - 8 Number of elements to extract
Input value inInverse bool Determines if the indices are counted from beginning or from end of the input array
Output value outValue1 Type& First output value
Output value outValue2 Type& Second output value
Output value outValue3 Type& Third output value
Output value outValue4 Type& Fourth output value
Output value outValue5 Type& Fifth output value
Output value outValue6 Type& Sixth output value
Output value outValue7 Type& Seventh output value
Output value outValue8 Type& Eighth output value

Errors

List of possible exceptions:

Error type Description
DomainError Index out of range in GetArrayElements_Deprecated.
DomainError Invalid inCount value in GetArrayElements_Deprecated.