ArraySetStringByAn

Sets a string value in an array associated with a specified AN.

Syntax

INTArraySetStringByAn(INT nAN, STRING sValue, INT x [, INT y [, INT z]])

nAN:

The AN associated with the array.

sValue:

The string value you would like to set.

x:

The index for the x–dimension.

y:

The index for the y–dimension.

z:

The index for the z–dimension.

Return Value

0 (zero) if successful, otherwise an error is returned.

Related Functions

ArrayCopy, ArrayCreate, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetIntByAn, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetString, ArrayGetStringByAn, ArrayIsDirty, ArraySetInt, ArraySetIntByAn, ArraySetIsDirty, ArraySetString, 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