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

DspArrayByAn

Displays an alarm list associated with a specified AN at the location of that AN. The array associated with the AN contains the alarm data. It is typically used as part of an alarm list or generic list Genie.

Syntax

INTDspArrayByAn(INT nAN)

nAN:

The AN associated the array that contains alarm data.

Return Value

0 (zero). If there is an error, 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, ArrayGetString, ArrayGetStringByAn, ArrayIsDirty, ArraySetInt, ArraySetIntByAn, ArraySetIsDirty, ArraySetString, ArraySetStringByAn, ArraySwap

Example

DspArrayByAn(hAn);

See Also

Published June 2018