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

AvsFilter_GetArrayElements

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 up to 8 individual elements from an array.

Syntax

void avs::AvsFilter_GetArrayElements
(
	const atl::Array<Type>& inArray,
	const int inStart,
	const int inCount,
	Type& outValue1,
	Type& outValue2,
	Type& outValue3,
	Type& outValue4,
	Type& outValue5,
	Type& outValue6,
	Type& outValue7,
	Type& outValue8
)

Parameters

Name	Type	Range	Description
inArray	const Array<Type>&		Input array
inStart	const int	0 -	First element index
inCount	const int	1 - 8	Number of elements to extract
outValue1	Type&		First output value
outValue2	Type&		Second output value
outValue3	Type&		Third output value
outValue4	Type&		Fourth output value
outValue5	Type&		Fifth output value
outValue6	Type&		Sixth output value
outValue7	Type&		Seventh output value
outValue8	Type&		Eighth output value

Errors

List of possible exceptions:

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