Retrieves a string from an array.
Syntax
STRING ArrayGetString(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 string, if successful. If unsuccessful, " " is returned. The error code can be obtained by calling the IsError Cicode function.
Related Functions
ArrayCreate, ArrayCopy, ArrayCreateByAn, ArrayDestroy, ArrayDestroyByAn, ArrayExists, ArrayExistsByAn, ArrayFillFromAlarmDataByAn, ArrayGetArrayByAn, ArrayGetInfo, ArrayGetInt, ArrayGetIntByAn, ArrayGetMapName, ArrayGetMapNameByAn, ArrayGetStringByAn, ArrayIsDirty, ArraySetInt, ArraySetIntByAn, ArraySetIsDirty, ArraySetString, 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