Back to FabImage Library websiteYou are here:
Start »
Function Reference »
Array Basics »
FisFilter_SetArrayElement
FisFilter_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: | fis |
Sets an element of an array to a new value.
Syntax
void fis::FisFilter_SetArrayElement
(
ftl::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 |
Reversed order in the 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