Cicode Programming Reference > Cicode Function Categories > Array Functions > ArrayGetArrayByAn

ArrayGetArrayByAn

Retrieves an array associated with a specified AN.

Syntax

INT ArrayGetArrayByAn(INT nAN)

nAN:

The AN number associated with the array that will be retrieved.

Return Value

The handle of the array. If unsuccessful, –1 is returned. The error code can be obtained by calling the IsError Cicode function.

Related Functions

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

Example

hArray = ArrayGetArrayByAn(hAn);

See Also

Published June 2018