ArrayGetInt

Retrieves an integer value from an array.

Syntax

INT ArrayGetInt(INT hArray, INT x [, INT y [, INT z]])

hArray:

The handle of the array.

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, the error code can be obtained by calling the IsError Cicode function.

Related Functions

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

Example

...
// Set the integer value at Array(1,2,3) to be 444
ArraySetInt(hArray, 444, 1, 2, 3);
// Get the integer value at Array(1,2,3)
value = ArrayGetInt(hArray, 1, 2, 3);
// value = 444
...

See Also

Array Functions