Alarm functions display alarms and their related alarm help pages, and acknowledge, disable, and enable alarms. They provide information about alarms and allow your operators to add comments to alarm records. You can also access alarms at the record level (on the alarms server) for more complex operations. (See also Alarm Filter Functions.)
Acknowledges alarms. |
|
Acknowledges alarms by record number. |
|
Acknowledges a specified alarm |
|
Determines if any alarms are active in the user's area. |
|
Returns the display format string of the specified alarm category. |
|
Clears acknowledged, inactive alarms from the active alarm list. |
|
Clear an alarm by its record number. |
|
Clear an alarm by its tag name. |
|
Allows users to add comments to alarm summary entries during runtime. |
|
AlarmCommentRecID |
Allows an operator to add a comment to a selected alarm summary or SOE entry during runtime. |
Counts the available alarms for the selected filter criteria. |
|
Counts the available alarms for specified equipment in conjunction with the selected filter criteria. |
|
Counts the available alarms for the selected alarm list. |
|
Deletes alarm summary entries that are currently displayed. |
|
Disables alarms. |
|
Disables alarms by record number. |
|
Disables alarms by tag name. |
|
Displays alarms. |
|
Adds a cluster to a client's alarm list. |
|
Determines if a cluster is included in a client's alarm list. |
|
Removes a cluster from a client's alarm list. |
|
Displays the latest, unacknowledged alarms. |
|
Displays the next page of alarms. |
|
Displays the previous page of alarms. |
|
Enables alarms. |
|
Enables alarms by record number. |
|
Enables alarms by tag name. |
|
Opens the alarm event queue. |
|
Searches for the first occurrence of an alarm category and type. |
|
Searches for the first occurrence of an alarm priority and type. |
|
Searches for the first occurrence of an alarm tag, name, and description. |
|
Gets the delay setting for an alarm. |
|
Gets the delay setting for an alarm via the alarm record number. |
|
Gets field data from the alarm record that is displayed at the specified AN. |
|
Gets alarm field data from the alarm record number. |
|
Gets information about an alarm list displayed at an AN. |
|
Retrieves the list of key(s) used to determine the order of the alarm list. |
|
Gets the thresholds of analog alarms. |
|
Gets the thresholds of analog alarms by the alarm record number. |
|
Displays the help page for the alarm where the cursor is positioned. |
|
Returns the priority and alarm state of the current highest priority alarm for the given equipment. |
|
Creates an alarms list at a specified AN. |
|
Destroys an alarms list at a specified AN. |
|
Displays an alarms list at a specified AN. |
|
Fills an alarm list at a specified AN to be used by another routine. |
|
Searches for the next occurrence of an alarm category and type. |
|
Searches for the next occurrence of an alarm priority and type. |
|
Searches for the next occurrence of an alarm tag, name, and description. |
|
Activates a time-stamped digital or time-stamped analog alarm |
|
Searches for the first occurrence of an alarm category (or priority) and type. |
|
Searches for the next occurrence of an alarm category (or priority) and type. |
|
Clears the filter of the specified filter source. Used to reset the filter set up by the Cicode function AlarmFilterForm(). |
|
Changes the delay setting for an alarm. |
|
Changes the delay set for an alarm via the alarm record number. |
|
Changes the display parameters for the alarm list displayed at an AN. |
|
AlarmSetQuery |
This function is now obsolete. Use the Alarm Filter Functions. |
Changes the thresholds of analog alarms. |
|
Changes the thresholds of analog alarms by the alarm record number. |
|
Splits an alarm summary entry which has no Off time. |
|
Appends a new blank record to the alarm summary. |
|
Commits the alarm summary record to the alarm summary device. |
|
Deletes alarm summary entries. |
|
Finds an alarm summary index for an alarm record and alarm on time. |
|
Gets the oldest alarm summary entry. |
|
Gets field information from an alarm summary entry. |
|
Gets the latest alarm summary entry. |
|
Gets the next alarm summary entry. |
|
Gets the previous alarm summary entry. |
|
Sets field information in an alarm summary entry. |
|
Duplicates an alarm summary entry. |
|
Retrieves a value that indicates a specified alarm's type. |
|
Acknowledges the alarm tag at the current cursor position in an active data browse session. |
|
AlmBrowseClear |
This function is now obsolete. |
Closes an alarm tags browse session. |
|
Disables the alarm tag at the current cursor position in an active data browse session. |
|
Enables the alarm tag at the current cursor position in an active data browse session. |
|
Gets the oldest alarm tags entry. |
|
Gets the field indicated by the cursor position in the browse session. |
|
Gets the next alarm tags entry in the browse session. |
|
Returns the number of records in the current browse session. |
|
Opens an alarm tags browse session. |
|
Gets the previous alarm tags entry in the browse session. |
|
Acknowledges the alarm at the current cursor position in an active data browse session. |
|
Clears the alarm at the current cursor position in an active data browse session. |
|
Closes an alarm summary browse session. |
|
Commits the value changes made by AlmSummarySetFieldValue(). |
|
Deletes alarm summary entries from the browse session. |
|
Deletes all alarm summary entries from the browse session. |
|
Disables the alarm at the current cursor position in an active data browse session. |
|
Enables the alarm at the current cursor position in an active data browse session. |
|
Gets the oldest alarm summary entry. |
|
Gets the field indicated by the cursor position in the browse session. |
|
Places the data browse cursor at the latest summary record from the last cluster of the available browsing cluster list. |
|
Gets the next alarm summary entry in the browse session. |
|
Retrieves the number of records in an alarm summary browse session. |
|
Opens an alarm summary browse session. |
|
Gets the previous alarm summary entry in the browse session. |
|
Sets the value of the field indicated by the cursor position in the browse session. AlmSummaryCommit() is required to commit the value changes. The value changes are discarded if the cursor moves away. |
|
This command is now deprecated. Use the AlmBrowseAck function instead. |
|
This command is now deprecated. |
|
This command is now deprecated. Use the AlmBrowseClose function instead. |
|
This command is now deprecated. Use the AlmBrowseDisable function instead. |
|
This command is now deprecated. Use the AlmBrowseEnable function instead. | |
This command is now deprecated. Use the AlmBrowseFirst function instead. | |
This command is now deprecated. Use the AlmBrowseGetField function instead. | |
This command is now deprecated. Use the AlmBrowseNext function instead. | |
This command is now deprecated. Use the AlmBrowseNumRecords function instead. | |
This command is now deprecated. Use the AlmBrowseOpen function instead. | |
This command is now deprecated. Use the AlmBrowsePrev function instead. | |
Returns the handle of the hardware alarm queue. |
See Also
Published June 2018