Back to Aurora Vision Library websiteYou are here:
Start »
Function Reference »
All Functions »
Array Composition »
RemoveArrayElement
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: |
avl |
Module: |
FoundationLite |
Removes an element at the given index from the input array.
Syntax
void avl::RemoveArrayElement
(
atl::Array<Type>& ioArray,
int inIndex,
bool inInverse,
Type& outRemovedValue
)
Parameters
|
Name |
Type |
Range |
Default |
Description |
|
ioArray |
Array<Type>& |
|
|
|
|
inIndex |
int |
0 - |
|
Index of element to be removed |
|
inInverse |
bool |
|
False |
Determines if the indices are counted from beginning or from end of the input array |
|
outRemovedValue |
Type& |
|
|
Value of removed element |
Errors
List of possible exceptions:
Error type |
Description |
DomainError |
Array index out of range in RemoveArrayElement. |