ArrayGetStringByAn

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

Syntax

STRING ArrayGetStringByAn(INT nAN, INT x [, INT y [, INT z]])

nAN:

The AN associated with 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 string, otherwise an error is returned.

Related Functions

ArrayCopy, ArrayCreate, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetIntByAn, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetString, 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 "abc"
ArraySetStringByAn(hAn, "abc", 1, 2, 3);
// Get the integer value at (1,2,3) of the array associated with hAn
value = ArrayGetStringByAn(hAn, 1, 2, 3);
// value = "abc"
...

See Also

Array Functions