CAmvAlarm::DeleteOptions()

This field contains the criteria for deleting an alarm instance. The criteria can be one or both of the following:

AM_ACK_CHAR	Alarm was acknowledged by operator.
AM_CLR_CHAR	Alarm was cleared (reset).

Comments

Alarms are deleted only if they meet the specified deletion criteria. The criteria are that the alarm has been cleared (returned to normal state) or acknowledged.

An alarm with delete options of AM_ACK_CHAR (acknowledged) is deleted when the operator acknowledges it, even if it has not been cleared.

An alarm with delete options of AM_CLR_CHAR (cleared) is automatically deleted when it clears even if it has not been acknowledged.

An alarm with delete options of AM_ACK_CHAR and AM_CLR_CHAR must be cleared and acknowledged before it can be deleted.

Syntax

CAmvAlarm* alarm_ptr

alarm_ptr->DeleteOptions()

Data Type

TCHAR*

Example

This example sets a verbose prompt for the user to tell them what the deletion requirements are.

if ((_tcschr(alarm_ptr->DeleteOptions(), AM_ACK_CHAR) != NULL)

&& (_tcschr(alarm_ptr->DeleteOptions(), AM_CLR_CHAR) != NULL))

Requirement = CAmvStateFilter::ack_clear_msg();

else if

((_tcschr(alarm_ptr->DeleteOptions(), AM_ACK_CHAR) != NULL)

&& (_tcschr(alarm_ptr->DeleteOptions(), AM_CLR_CHAR) == NULL))

Requirement = CAmvStateFilter::ack_only_msg();

else if

((_tcschr(alarm_ptr->DeleteOptions(), AM_ACK_CHAR) == NULL)

&& (_tcschr(alarm_ptr->DeleteOptions(), AM_CLR_CHAR) != NULL))

Requirement = CAmvStateFilter::clear_only_msg();