Use this method to shelve an alarm in the Alarm Summary object.
Syntax
object.ShelveAlarm DataPoint, ShelveDurationNumber, [intErrorMode], [BsendMsg]
Properties
The ShelveAlarm method syntax has these parts:
|
Part |
Description |
|
object |
An object expression that evaluates to an object in the Applies To list. |
| DataPoint | String. The tag name. |
| ShelveDurationNumber | Long. |
| intErrorMode |
Integer. (Optional). The error mode. 0 (default) – Allows the subroutines to provide the error messages. Errors are displayed in the form of a message box. If no entry is made for the intErrorMode parameter, the default is used. 1 – Allows the user to handle the error messages. Errors in the subroutines are passed back to the calling routine for handling. 2 – Writes errors to all destinations. No error messages display. Instead, the errors are written to all iFIX destinations, including the Alarm History window destinations using SendOperatorMessage. |
| BsendMsg | Boolean. (Optional). If TRUE, the message "value changed byxxx" will be sent to the alarm destinations. If FALSE, the message will be suppressed. |
Return Values
- Invalid shelve policy name
- Invalid shelve duration
- Alarm disabled
- Alarm shelving not enabled
- Alarm already shelved
- Security access error
- Unknown error
