TagsDBAddClassMember
- Last UpdatedOct 29, 2026
- 2 minute read
This function adds a new class member to an existing class during run time.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
TagsDBAddClassMember |
Tags Database |
Synchronous |
No |
Supported (see Notes below) |
Not supported |
Not supported |
Not supported |
Not supported |
Syntax
TagsDBAddClassMember( strClassName, strMemberName, strMemberType, strDescription )
TagsDBAddClassMember ( strClassName , strMemberName , { strMemberType | "Boolean" | "Integer" | "Real" | "String" } ,strDescription)
strClassName
The name of the class to which the member will be added.
strMemberName
The name of the class member to be added.
strMemberType
The data type of the class member to be added. This parameter accepts only the following values: "Boolean", "Integer", "Real", or "String".
strDescription
A description of the class member to be added.
Returned value
This function returns one of the following possible values:
|
Value |
Description |
|---|---|
|
-4 |
The specified class does not exist in the tags database. |
|
-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.