Back to Aurora Vision Library website

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

AvsFilter_SetArrayElement


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
Module: FoundationLite

Sets an element of an array to a new value.

Syntax

void avs::AvsFilter_SetArrayElement
(
	atl::Array<Type>& ioArray,
	int inIndex,
	bool inInverse,
	const Type& inNewValue
)

Parameters

Name Type Range Default Description
Input will be modified ioArray Array<Type>&
Input value inIndex int 0 - Index within the array
Input value inInverse bool False Determines if the indices are counted from beginning or from end of the input array
Input value inNewValue const Type& Value to be set

Examples
inArray = {1,4,3,2,5}
inIndex = 3
inNewValue = 6 		outArray = {1,4,3,6,5}

Errors

List of possible exceptions:

Error type Description
DomainError Index out of range in SetArrayElement.

See Also