Cicode Functions in Citect SCADA 2018

Getting Started > What's New > Cicode Functions in Citect SCADA 2018

Cicode Functions in Citect SCADA 2018

Some Cicode functions have been introduced or modified. The following sections detail these changes:

Alarm Filter Functions

AlarmFilterEditAppendEquipment

Appends the provided expression that can include equipment names or category to the current filter session content without validation.

Alarm Functions

AlarmListCreate	Creates an alarms list at a specified AN.
AlarmListDisplay	Displays an alarms list at a specified AN.
AlarmListDestroy	Destroys an alarms list at a specified AN.

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 is associated with a specified AN.
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 associated with an array at 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 alarms list. The array that contains the alarm data is associated with the specified AN.

Display Functions

DspAnSetName	Using a valid AN set the name of an animation object.
DspGetAnFromName	Name used to retrieve the AN of an object on the page.
DspGetAnRawExtent	Gets the extent of the object from the graphics page at the specified AN.
DspGetNameFromAN	Using a valid An the animation name of the object is returned.
DspGetMetadataFromName	Name used to retrieve the metadata of an object on the page.
DspSetCurColor	Sets the color of the focus rectangle.
DspSetMetadataFromName	Name used to set the metadata of an object on the page.

Map Functions

MapClose	Deletes a previously created map.
MapExists	Check if the map exists using a returned error code.
MapKeyCount	Retrieves the number of keys in a map.
MapKeyDelete	Delete a key and its value from a map.
MapKeyExists	Check if a key exists in a map.
MapKeyFirst	Retrieves the first key in a maps so that all the keys in a map can be discovered.
MapKeyNext	Retrieves the next key after the supplied key in a map so that all the keys in a map can be discovered.

Menu Functions

MenuNodeGetExpanded	Returns the expansion state value of the specified menu node.
MenuNodeSetExpanded	Sets the expansion state value of the specified menu node.

Super Genie Functions

AssWinReplace

Removes the associations on a specified Super Genie window and applies any pending associations.

Tag Functions

TagGetValue

Reads the value, quality and timestamp of a tag based on the tag subscription.

Windows Functions

WinGetClicked	Gets the number of the Citect SCADA window that has most recently been clicked on using the left mouse button.
WinNewPinAt	Opens a new display window at a specified location, relative to the current active window, with a selected page displayed.
WinFreeEx	Removes the active display window and allows you to pass a Windows handle to the function for closing the window.
WinGetFirstChild	Gets the window number of the first child of a parent window.
WinGetNextChild	Gets the window number of the next child in a child link.

Modified Functions

Alarm Functions

AlarmDisable	EndTime and Comment arguments have been added to support alarm shelving.
AlarmDisableRec	EndTime and Comment arguments have been added to support alarm shelving.
AlarmDisableTag	EndTime and Comment arguments have been added to support alarm shelving.
AlarmEnable	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.
AlarmEnableRec	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.
AlarmEnableTag	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.
AlarmGetDsp	Alarm response properties are now accessible via the Field argument.
AlarmGetFieldRec	Alarm response properties are now accessible via the Field argument.
AlmBrowseDisable	EndTime and Comment arguments have been added to support alarm shelving.
AlmBrowseEnable	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.
AlmBrowseGetField	Alarm response properties are now accessible via the Field argument.
AlmSummaryDisable	EndTime and Comment arguments have been added to support alarm shelving.
AlmSummaryEnable	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.
AlmTagDisable	EndTime and Comment arguments have been added to support alarm shelving.
AlmTagEnable	bAcknowledge argument has been added to force acknowledgment of an alarm after it is enabled.

Display Functions

DspAnInfo	Mode 3 added as an option for the nType argument.
DspText	bTooltip argument added.
DspStr	bTooltip argument added.

Equipment Functions

AssEquipParameters	Associates a set of equipment parameters defined in System Model \| Equipment \| Runtime Parameters with a page.
EquipGetParameter	Reads a runtime parameter of an equipment database record from the EQPARAM.RDB database file.

Form Functions

FormButton	"Disabled" has been added as an option for the Mode argument.
FormPrompt	Width and Height arguments have been added to create an area that the prompt string will wrap within.

String Functions

StrEndsWith	Verifies whether the given string ends with a specific string.
StrListContainsItem	Checks whether the string passed is an item contained in a delimited list of strings.
StrSplit	Splits a string into sub-strings based on the specified delimiter. Sub-strings are stored in a new array and a handle to this array is returned.
StrTruncFontToolkit	Returns a truncated string with ellipsis, and sets an AN with a tooltip containing the complete string if a truncation occurs.

Published June 2018