Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > Alarm Functions

Alarm Functions

Following are functions relating to alarms:

AlarmAck

Acknowledges alarms.

AlarmAckRec

Acknowledges alarms by record number.

AlarmActive

Determines if any alarms are active in the user's area.

AlarmCatGetFormat

Returns the display format string of the specified alarm category.

AlarmClear

Clears acknowledged, inactive alarms from the active alarm list.

AlarmClearRec

Clear an alarm by its record number.

AlarmComment

Allows users to add comments to alarm summary entries.

AlarmDelete

Deletes alarm summary entries.

AlarmDisable

Disables alarms.

AlarmDisableRec

Disables alarms by record number.

AlarmDsp

Displays alarms.

AlarmDspClusterAdd Adds a cluster to a client's alarm list.
AlarmDspClusterInUse Determines if a cluster is included in a client's alarm list.
AlarmDspClusterRemove Removes a cluster from a client's alarm list.

AlarmDspLast

Displays the latest, unacknowledged alarms.

AlarmDspNext

Displays the next page of alarms.

AlarmDspPrev

Displays the previous page of alarms.

AlarmEnable

Enables alarms.

AlarmEnableRec

Enables alarms by record number.

AlarmEventQue

Opens the alarm event queue.

AlarmFirstCatRec

Searches for the first occurrence of an alarm category and type.

AlarmFirstPriRec

Searches for the first occurrence of an alarm priority and type.

AlarmFirstTagRec

Searches for the first occurrence of an alarm tag, name, and description.

AlarmGetDelay

Gets the delay setting for an alarm.

AlarmGetDelayRec

Gets the delay setting for an alarm via the alarm record number.

AlarmGetDsp

Gets field data from the alarm record that is displayed at the specified AN.

AlarmGetFieldRec

Gets alarm field data from the alarm record number.

AlarmGetInfo

Gets information about an alarm list displayed at an AN.

AlarmGetOrderbyKey

Retrieves the list of key(s) used to determine the order of the alarm list.

AlarmGetThreshold

Gets the thresholds of analog alarms.

AlarmGetThresholdRec

Gets the thresholds of analog alarms by the alarm record number.

AlarmHelp

Displays the help page for the alarm where the cursor is positioned.

AlarmNextCatRec

Searches for the next occurrence of an alarm category and type.

AlarmNextPriRec

Searches for the next occurrence of an alarm priority and type.

AlarmNextTagRec

Searches for the next occurrence of an alarm tag, name, and description.

AlarmNotifyVarChange

Activates a time-stamped digital or time-stamped analog alarm

AlarmQueryFirstRec

Searches for the first occurrence of an alarm category (or priority) and type.

AlarmQueryNextRec

Searches for the next occurrence of an alarm category (or priority) and type.

AlarmSetDelay

Changes the delay setting for an alarm.

AlarmSetDelayRec

Changes the delay set for an alarm via the alarm record number.

AlarmSetInfo

Changes the display parameters for the alarm list displayed at an AN.

AlarmSetQuery

Specifies a query .to be used in selecting alarms for display.

AlarmSetThreshold

Changes the thresholds of analog alarms.

AlarmSetThresholdRec

Changes the thresholds of analog alarms by the alarm record number.

AlarmSplit

Duplicates an alarm summary entry where the cursor is positioned.

AlarmSumAppend

Appends a new blank record to the alarm summary.

AlarmSumCommit

Commits the alarm summary record to the alarm summary device.

AlarmSumDelete

Deletes alarm summary entries.

AlarmSumFind

Finds an alarm summary index for an alarm record and alarm on time.

AlarmSumFirst

Gets the oldest alarm summary entry.

AlarmSumGet

Gets field information from an alarm summary entry.

AlarmSumLast

Gets the latest alarm summary entry.

AlarmSumNext

Gets the next alarm summary entry.

AlarmSumPrev

Gets the previous alarm summary entry.

AlarmSumSet

Sets field information in an alarm summary entry.

AlarmSumSplit

Duplicates an alarm summary entry.

AlarmSumType

Retrieves a value that indicates a specified alarm's type.

AlmSummaryAck

Acknowledges the alarm at the current cursor position in an active data browse session.

AlmSummaryClear

Clears the alarm at the current cursor position in an active data browse session.

AlmSummaryClose

Closes an alarm summary browse session.

AlmSummaryCommit

Commits the alarm summary record to the alarm summary device.

AlmSummaryDelete

Deletes alarm summary entries from the browse session.

AlmSummaryDeleteAll

Deletes all alarm summary entries from the browse session.

AlmSummaryDisable

Disables the alarm at the current cursor position in an active data browse session.

AlmSummaryEnable

Enables the alarm at the current cursor position in an active data browse session.

AlmSummaryFirst

Gets the oldest alarm summary entry.

AlmSummaryGetField

Gets the field indicated by the cursor position in the browse session.

AlmSummaryLast

Places the data browse cursor at the latest summary record from the last cluster of the available browsing cluster list.

AlmSummaryNext

Gets the next alarm summary entry in the browse session.

AlmSummaryOpen

Opens an alarm summary browse session.

AlmSummaryPrev

Gets the previous alarm summary entry in the browse session.

AlmSummarySetFieldValue

Sets the value of the field indicated by the cursor position in the browse session.

AlmTagsAck

Acknowledges the alarm tag at the current cursor position in an active data browse session.

AlmTagsClear

Clears the alarm tag at the current cursor position in an active data browse session.

AlmTagsClose

Closes an alarm tags browse session.

AlmTagsDisable

Disables the alarm tag at the current cursor position in an active data browse session.

AlmTagsEnable

Enables the alarm tag at the current cursor position in an active data browse session.

AlmTagsFirst

Gets the oldest alarm tags entry.

AlmTagsGetField

Gets the field indicated by the cursor position in the browse session.

AlmTagsNext

Gets the next alarm tags entry in the browse session.

AlmTagsNumRecords

Returns the number of records in the current browse session.

AlmTagsOpen

Opens an alarm tags browse session.

AlmTagsPrev

Gets the previous alarm tags entry in the browse session.

HwAlarmQue Returns the handle of the hardware alarm queue.

See Also

Cicode Functions