Back to FabImage Library websiteYou are here:
Start »
Function Reference »
All Functions »
Array Basics »
FisFilter_GetArrayElements_OrNil
FisFilter_GetArrayElements_OrNil
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
(
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 |
|
inArray |
const Array<Type>& |
|
|
Input array |
|
inStart |
const int |
0 - |
|
First element index |
|
inCount |
const int |
1 - 8 |
|
Number of elements to extract |
|
inInverse |
bool |
|
|
Determines if the indices are counted from beginning or from end of the input array |
|
outValue1 |
typename ToConditionalType<Type>::Type& |
|
|
First output value |
|
outValue2 |
typename ToConditionalType<Type>::Type& |
|
|
Second output value |
|
outValue3 |
typename ToConditionalType<Type>::Type& |
|
|
Third output value |
|
outValue4 |
typename ToConditionalType<Type>::Type& |
|
|
Fourth output value |
|
outValue5 |
typename ToConditionalType<Type>::Type& |
|
|
Fifth output value |
|
outValue6 |
typename ToConditionalType<Type>::Type& |
|
|
Sixth output value |
|
outValue7 |
typename ToConditionalType<Type>::Type& |
|
|
Seventh output value |
|
outValue8 |
typename ToConditionalType<Type>::Type& |
|
|
Eighth output value |
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Invalid inCount value in GetArrayElements_OrNil. |
DomainError |
Negative inStart in GetArrayElements_OrNil. |