TagsDBRemoveAlarm

This function removes an alarm condition from a project tag during run time.

Function	Group	Execution	Windows	Embedded	Thin Client	Mobile Access
TagsDBRemoveAlarm	Tags Database	Synchronous	Supported (see “Notes” below)	Not supported	Not supported	Not supported

Syntax

  TagsDBRemoveAlarm( strTagName, numAlarmType )

strTagName

The name of the project tag from which the alarm condition will be removed.

numAlarmType

The alarm condition to be removed, identified by one of the following values:

This function returns one of the following possible values:

Value	Description
`-4`	Project tag (as specified by strTagName) does not exist.
`-3`	Wrong parameter type or inconsistent value.
`-2`	Invalid number of parameters.
`-1`	The function TagsDBBeginEdit was not executed successfully before this function was called.
`0`	Function executed successfully.

The following restrictions apply to the execution of this function:

The function can only be executed on the project server — it cannot be called by a Graphics Script, Screen Script, or Command animation running on a project client;
The function TagsDBBeginEdit must have been executed previously, in order to lock the tags database for editing; and
The function TagsDBEndEdit must be executed when the editing is finished, in order to release the tags database and resume normal run-time operations.

For more information about the Tags Database functions and examples of how to use them, see Edit the tags database during run time.