Cicode Functions in Citect SCADA 2018
- Last UpdatedJul 13, 2023
- 6 minute read
Some Cicode functions have been introduced or modified. The following sections detail these changes:
New Functions
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
|
AlarmCommentRecID |
Allows an operator to add a comment to a selected alarm summary or SOE entry during runtime. |
|
AlarmHighestPriority |
Returns the alarm priority and/or state of the current highest priority alarm for the given equipment in conjunction with the selected filter criteria. |
|
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. |
|
AlarmListFill |
Fills an alarms list at a specified AN to be used by another routine (e.g. the interlocks processing routine). |
|
AlarmTagFromEquipment |
Returns the first alarm tag associated with a piece of equipment. |
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. |
|
DspClearClip |
Clears the clipping rectangle surrounding the object or group of objects. |
|
DspGetAnFromName |
Name used to retrieve the AN of an object on the page. |
|
DspGetAnFromNameRelative |
Retrieves the animation number (AN) of an object on the page relative to a given Animation Number(AN). |
|
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. |
|
DspGetMetadataFromNameRelative |
Retrieves the metadata of an object on the page relative to a given Animation Number (AN). |
|
DspSetCurColor |
Sets the color of the focus rectangle. |
|
DspSetMetadataFromName |
Name used to set the metadata of an object on the page. |
|
DspSetPopupMenuFont |
Sets the font for popup menu text at runtime. |
Equipment Database Functions
|
EquipGetParameter |
Reads a runtime parameter of an equipment database record from the EQPARAM.RDB database file. |
|
EquipRefBrowseClose |
Terminates an active data browse session and cleans up resources associated with the session. |
|
EquipRefBrowseFirst |
Places the reference browse cursor at the first record. |
|
EquipRefBrowseGetField |
Retrieves the value of the specified field from the record the data browse cursor is currently referencing. |
|
EquipRefBrowseNext |
Moves the data browse cursor forward one record. |
|
EquipRefBrowseNumRecords |
Returns the number of records that match the filter criteria. |
|
EquipRefBrowseOpen |
Initiates a new browse session and returns a handle to the new session that can be used in subsequent equipment reference browse function calls. |
|
EquipRefBrowsePrev |
Moves the data browse cursor back one record. |
Map Functions
|
MapClear |
Clears all entries in a map and returns the error status. |
|
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. |
|
MapOpen |
Creates a new map or to open an existing map. |
|
MapValueGet |
Retrieves the value from a key in a map. |
|
MapValueSet |
Sets a value of a map key. |
|
MapValueSetQuality |
Sets the quality of a property in a map. |
Menu Functions
|
MenuGetNodeByPath |
Returns a menu handle corresponding to a menu item expressed as a string path in the format <level>.<level>.<level>.<level>. |
|
MenuNodeGetCurr |
Allows you to get the handle of the menu node when this associated command is called. |
|
MenuNodeGetDepth |
Returns the depth of a specified menu node within a menu hierarchy. |
|
MenuNodeGetExpanded |
Returns the expansion state value of the specified menu node. |
|
MenuNodeGetTargetPage |
Returns the target page for a specified menu node. |
|
MenuNodeSetExpanded |
Sets the expansion state value of the specified menu node. |
Page Functions
|
PageFileInfoEx |
Returns the width, height, content type, parent or title of an unopened page. |
Screen Profile Functions
|
ResetScreenProfile |
Returns all top level windows back to their original screen starting position as defined by the screen profile in a multi-monitor setup. |
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. |
|
StrReplace |
Replaces a substring in a string with replacement substring. |
|
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. |
Super Genie Functions
|
AssEquipParameters |
Associates a set of equipment parameters defined in System Model | Equipment | Runtime Parameters with a page. |
|
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 Plant SCADA window that has most recently been clicked on using the left mouse button. |
|
WinGetName |
Gets the name previously associated with a particular window number using WinSetName. |
|
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. |
|
WinGetParent |
Retrieves the window number of the specified window's parent or root window. |
|
WndMonitorInfoEx |
Returns information about a particular monitor using the screen name of the screen profile. |
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. |
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. |
Reinstated Functions
No functions have been re-instated in Citect SCADA 2018.
Deprecated Functions
No functions have been deprecated for Citect SCADA 2018.
Removed Functions
No functions have been removed for Citect SCADA 2018.