TagsDBRemoveClass
- Last UpdatedOct 29, 2026
- 1 minute read
This function removes an existing class from the tags database during run time.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TagsDBRemoveClass |
Tags Database |
Synchronous |
No |
Supported (see Notes below) |
Not supported |
Not supported |
Not supported |
Not supported |
Syntax
TagsDBRemoveClass( strClassName )
TagsDBRemoveClass ( strClassName )
strClassName
The name of the class to be removed.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
-5 |
The specified class does not exist in the tags database. |
|
-4 |
The specified class is being used (that is, it has one or more tags associated with it). |
|
-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. |
Notes
The following restrictions apply to the execution of this function:
-
The 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;
-
The TagsDBBeginEdit function must have been executed previously, in order to lock the tags database for editing; and
-
The TagsDBEndEdit function must be executed when the editing is done, 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.