Description: An HPI User acknowledges an alarm to indicate that it is aware of the alarm and to influence platform-specific alarm annunciation that may be provided by the implementation. Typically, an implementation ignores acknowledged alarms when announcing an alarm on annunciation devices such as audible sirens and dry contact closures. However, alarm annunciation is implementation-specific.

An acknowledged alarm will have the Acknowledged field in the alarm entry set to True.

DomainAlarms are acknowledged by one of two ways: a single alarm entry by DomainAlarmId regardless of severity or as a group of alarm entries by Severity regardless of DomainAlarmId.

To acknowledge all alarms contained within the DAT, set the Severity parameter to allSeverities(256), and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED.

To acknowledge all alarms of a specific severity contained within the DAT, set the Severity parameter to the appropriate value, and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED.

To acknowledge a single alarm entry, set the DomainAlarmId parameter to a value other than SAHPI_ENTRY_UNSPECIFIED. The DomainAlarmId must be a valid identifier for an alarm entry present in the DAT at the time of the function call.

If an alarm has been previously acknowledged, acknowledging it again has no effect. However, this is not an error.

If the DomainAlarmId parameter has a value other than SAHPI_ENTRY_UNSPECIFIED, the Severity parameter is ignored.

If the DomainAlarmId parameter is passed as SAHPI_ENTRY_UNSPECIFIED, and no alarms are present that meet the requested Severity, this function will have no effect. However, this is not an error.

SAHPI_ENTRY_UNSPECIFIED is defined as the same value as SAHPI_FIRST_ENTRY, so using either symbol will have the same effect. However, SAHPI_ENTRY_UNSPECIFIED should be used with this function for clarity.