You are here: Start » Function Reference » Array Basics » AvsFilter_GetArrayElement_OrNil_Deprecated

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

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

Syntax

void avs::AvsFilter_GetArrayElement_OrNil_Deprecated
(
	const atl::Array<Type>& inArray,
	int inIndex,
	bool inInverse,
	typename atl::ToConditionalType<Type>::Type& outConditionalValue
)

Parameters

Name	Type	Range	Default	Description
inArray	const Array<Type>&			Input array
inIndex	int	0 -		Index within the array
inInverse	bool		False	Reversed order in the array
outConditionalValue	typename ToConditionalType<Type>::Type&			Element from the array