Back to Aurora Vision Library Lite website

You are here: Start » All Functions » Array Basics » AvsFilter_GetArrayArrayElement_OrNil

AvsFilter_GetArrayArrayElement_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: avs

Extracts a single element from an array at the specified index; returns NIL if the index is out of range.

Syntax

void avs::AvsFilter_GetArrayArrayElement_OrNil
(
	const atl::Array<atl::Array<Type>>& inArray,
	int inRow,
	int inColumn,
	typename atl::ToConditionalType<Type>::Type& outConditionalValue
)

Parameters

Name Type Range Default Description
Input value inArray const Array<Array<Type>>& Input array
Input value inRow int 0 -
Input value inColumn int 0 -
Output value outConditionalValue typename ToConditionalType<Type>::Type& Element from the array

Errors

List of possible exceptions:

Error type Description
DomainError Negative index in GetArrayArrayElement.