TagsDBGetAlarm

This function gets the properties of an alarm condition during run time.

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

Syntax

  TagsDBGetAlarm( strTagName, numAlarmType, numProperty )  
Web Studio Help tions tagsdb tagsdbgetalarm.xml d433115e123 TagsDBGetAlarm

strTagName
The name of the project tag on which the alarm condition is set.
numAlarmType
The alarm condition, identified by one of the following values:
Value Alarm Type
1 HiHi
2 Hi
4 Lo
8 LoLo
16 Rate
32 DeviationP
64 DeviationM
Tip: To get tag properties on project tags, use the function TagsDBGetTagProperty.
numProperty
The specific property of the alarm condition, identified by one of the following values:
Value Property Data Type
0 Limit value Real
1 Message String
2 Alarm group (or worksheet) number Integer
3 Priority Integer
4 Selection String
5 to 14 Custom field String

Returned value

If this function is executed succesfully, then it returns the value of the specified property. Otherwise, it returns one of the following possible values:
Value Description
-4 Project tag or alarm type does not exist.
-3 Wrong parameter type or inconsistent value.
-2 Invalid number of parameters.

Notes

This 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.

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

TagsDBGetAlarm