ArrayGetIntByAn

Retrieves an integer value from an array associated with a specified AN.

Syntax

INT ArrayGetIntByAn(INT nAN, INT x [, INT y [, INT z]])

nAN:

The AN number.

x:

The index for the x–dimension.

y:

The index for the y–dimension.

z:

The index for the z–dimension.

Return Value

The requested integer, if successful. If unsuccessful, –1 is returned. The error code can be obtained by calling the IsError Cicode function.

Related Functions

ArrayCopy, ArrayCreate, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetString, ArrayGetStringByAn, ArrayIsDirty, ArraySetInt, ArraySetIntByAn, ArraySetIsDirty, ArraySetString, ArraySetStringByAn, ArraySwap, DspArrayByAn

Example

...
// Set the integer value at (1,2,3) of the array associated with hAn to be 444
ArraySetIntByAn(hAn, 444, 1, 2, 3);
// Get the integer value at (1,2,3) of the array associated with hAn
value = ArrayGetIntByAn(hAn, 1, 2, 3);
// value = 444
...

See Also

Array Functions