TagsDBGetTagProperty
- Last UpdatedOct 29, 2026
- 2 minute read
TagsDBGetTagProperty is a built-in function that gets the value of a specified tag property during run time.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TagsDBGetTagProperty |
Tags Database |
Synchronous |
Yes |
Supported (see Notes below) |
Not supported |
Not supported |
Not supported |
Not supported |
Syntax
TagsDBGetTagProperty(strTagName,numPropertyID)
TagsDBGetTagProperty ( strTagName , { numPropertyID | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 } )
strTagName
The name of the project tag from which the tag property will be gotten.
numPropertyID
The tag property to get, identified by one of the following values:
|
Value |
Property |
Data Type |
Same as… |
|---|---|---|---|
|
0 |
Tag name |
String |
tagname->Name |
|
1 |
Array size |
Integer |
tagname->Size |
|
2 |
Data type |
String ("Boolean", "Integer", "Real", "String", "classname") |
- |
|
3 |
Description |
String |
tagname->Description |
|
4 |
Scope |
Integer (0 for Local, 1 for Server) |
- |
|
5 |
Startup value |
String |
- |
|
6 |
Minimum value |
Real |
tagname->Min |
|
7 |
Maximum value |
Real |
tagname->Max |
|
8 |
Engineering unit |
String |
tagname->Unit |
|
9 |
Retentive value |
Integer (0 for disabled, 1 for enabled) |
- |
|
10 |
Retentive properties |
Integer (0 for disabled, 1 for enabled) |
- |
|
11 |
Dead band |
Real |
- |
|
12 |
Smoothing |
Integer (0 for disabled, 1 for enabled) |
- |
|
13 |
UA External Availability |
Integer (0 for Disabled, 1 for Read Only, 2 for Read/Write) |
- |
In some cases, as shown above, calling this function is the same as referencing a tag field (for example, tagname->property).
To get alarm conditions on project tags, use the TagsDBGetAlarm function.
Other tag properties that are not listed above cannot be gotten during run time.
Return value
If this function is executed successfully, it returns the value of the specified tag property. Otherwise, it returns one of the following possible values:
|
Value |
Description |
|---|---|
|
-2 |
Invalid number of parameters. |
|
-3 |
Wrong parameter type or inconsistent value. |
|
-4 |
Project tag (as specified by strTagName) does not exist. |
Notes
This function can be executed only on the project runtime server — it cannot be called by a Graphics Script, Screen Script, or Command animation running on a thin client.
For more information about the Tags Database functions and examples of how to use them, see Using TagsDB functions to edit the tags database during run time.