ArraySetString

Sets a string value in an array.

Syntax

INTArraySetString(INT hArray, STRING sValue, INT x [, INT y [, INT z]])

hArray:

The handle of 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

If unsuccessful, an error code will be returned by the IsError Cicode function.

Related Functions

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

Example

// Set the string value at Array(1,2,3) to be “abc”
ArraySetString(hArray, “abc”, 1, 2, 3);
// Get the integer value at Array(1,2,3)
value = ArrayGetString(hArray, 1, 2, 3);
// value = “abc”
...

See Also

Published June 2018