TagsDBAddClassMember

This function adds a new class member to an existing class during run time.

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

Syntax

  TagsDBAddClassMember( strClassName, strMemberName, strMemberType, strDescription )  
Web Studio Help tagsdb tagsdbaddclassmember.xml d430279e122 TagsDBAddClassMember

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 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;
  • The function TagsDBBeginEdit must have been executed previously, in order to lock the tags database for editing; and
  • The function TagsDBEndEdit must be executed when the editing is finished, in order to release the tags database and resume normal run-time operations.

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

TagsDBAddClassMember