Back to FabImage Library website

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

FisFilter_GetArrayElements_OrNil_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 or NIL for indices out of range.

Syntax

void fis::FisFilter_GetArrayElements_OrNil_Deprecated
(
	const ftl::Array<Type>& inArray,
	const int inStart,
	const int inCount,
	bool inInverse,
	typename ftl::ToConditionalType<Type>::Type& outValue1,
	typename ftl::ToConditionalType<Type>::Type& outValue2,
	typename ftl::ToConditionalType<Type>::Type& outValue3,
	typename ftl::ToConditionalType<Type>::Type& outValue4,
	typename ftl::ToConditionalType<Type>::Type& outValue5,
	typename ftl::ToConditionalType<Type>::Type& outValue6,
	typename ftl::ToConditionalType<Type>::Type& outValue7,
	typename ftl::ToConditionalType<Type>::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 typename ToConditionalType<Type>::Type& First output value
Output value outValue2 typename ToConditionalType<Type>::Type& Second output value
Output value outValue3 typename ToConditionalType<Type>::Type& Third output value
Output value outValue4 typename ToConditionalType<Type>::Type& Fourth output value
Output value outValue5 typename ToConditionalType<Type>::Type& Fifth output value
Output value outValue6 typename ToConditionalType<Type>::Type& Sixth output value
Output value outValue7 typename ToConditionalType<Type>::Type& Seventh output value
Output value outValue8 typename ToConditionalType<Type>::Type& Eighth output value