SetEnable
Deprecated. Do not use in new code.
(Alarm Manager module)
| Description: | Tell the Alarm Manager to enable or disable an alarm. This function handles the attribution of changes to a user based on the tag's metadata. Use instead of the older Enable function when writing new code. |
| Returns: | Invalid (see parameter, FeedBack) |
Usage: ![]() |
Script Only. |
| Function Groups: | Alarm |
| Related to: | Register (Alarm Manager) | Enable |
Format: ![]() |
\AlarmManager\SetEnable(TagName, AlarmObj, Disable, InhibitParm, FeedBack); |
| Parameters: |
| TagName |
| Required. The name of the tag that owns the alarm. |
| AlarmObj |
| Required. An instance of the alarm module. |
| Disable |
| Boolean. Set TRUE to disable the alarm, FALSE to enable. |
| FeedBack |
| Numeric. Indicates the result of the action. Set to 1 if the alarm was enabled or disable, and 0 if no operation was performed. |
| Comments: | The SetEnable subroutine always returns Invalid. |
