Back to Aurora Vision Library Lite website
You are here: Start » 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 |
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 | |
---|---|---|---|---|---|
ioArray | Array<Type>& | ||||
inIndex | int | 0 - | Index within the array | ||
inInverse | bool | False | Determines if the indices are counted from beginning or from end of the input array | ||
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
- AvsFilter_GetArrayElement – Extracts a single element from an array at the specified index.
- AvsFilter_SetMultipleArrayElements – Sets elements of an array to new values.