TagsDBBeginEdit
- Last UpdatedOct 29, 2026
- 2 minute read
TagsDBBeginEdit is a built-in function that locks the tags database for editing during run time. You must call this function before you call any other Tags Database functions to add or remove project tags or set tag properties.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TagsDBBeginEdit |
Tags Database |
Synchronous |
No |
Supported (see Notes below) |
Not supported |
Not supported |
Not supported |
Not supported |
Syntax
TagsDBBeginEdit()
TagsDBBeginEdit ( )
This function has no parameters.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
0 |
Function executed successfully. |
|
-1 |
Project runtime is busy; another function is editing the tags database. Try again later. |
|
-2 |
Invalid number of parameters. |
|
-3 |
Project runtime is busy; an Alarm or Trend task is using the tags database. Try again later. |
Notes
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; and
-
The function TagsDBEndEdit must be executed when the editing is finished, in order to release the tags database and resume normal runtime operations.
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.
Please note this function has a persistent effect, which means that if you call the function to lock the tags database during run time and then stop the project, the database will remain locked and you will not be able to manually edit it.
Restarting the project may or may not unlock the database, depending on how you designed your project and which function call locked the database in the first place. As such, while the project is stopped, you should use the Watch window to manually call the function TagsDBEndEdit. When it is successfully executed, you can safely restart the project.