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

Array Functions

Citect SCADA supports the following array functions:

ArrayCopy

Makes a copy of an array.

ArrayCreate

Creates an array.

ArrayCreateByAn

Creates an array at a specified AN.

ArrayDestroy

Destroys an array.

ArrayDestroyByAn

Destroys an array associated with the specified AN.

ArrayExists

Determines if an array with a specified handle exists.

ArrayExistsByAn

Determines if an array associated with a specified AN exists.

ArrayFillFromAlarmDataByAn

This function is used to fill an array with information from internal alarm record caches.

ArrayGetArrayByAn

Retrieves an array associated with a specified AN.

ArrayGetInfo

Retrieves the size of the x–, y–, or z–dimension for an array.

ArrayGetInt

Retrieves an integer value from an array.

ArrayGetIntByAn

Retrieves an integer value from an array associated with a specified AN.

ArrayGetMapName

Retrieves the name of the map associated with an array.

ArrayGetMapNameByAn

Retrieves the name of the map for an array associated with a specified AN.

ArrayGetString

Retrieves a string from an array.

ArrayGetStringByAn

Retrieves a string from an array associated with a specified AN.

ArrayIsDirty

Determines if an array is ‘dirty’ (information in the array has changed).

ArraySetInt

Sets an integer value within an array.

ArraySetIntByAn

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

ArraySetIsDirty

Allows you to indicate that an array is dirty (meaning the information in the array has changed).

ArraySetString

Sets a string value in an array.

ArraySetStringByAn

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

ArraySwap

Swaps the contents of two arrays.

DspArrayByAn

Displays an alarm list associated with a specified AN at the location of that AN.

See Also

Published June 2018