TagsDBAddTag

This function adds a new project tag to the tags database during run time.

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

Syntax

  TagsDBAddTag( strTagName, optstrTagType, optNumArraySize, optstrDescription, optNumScope )  
Web Studio Help nctions tagsdb tagsdbaddtag.xml d431039e125 TagsDBAddTag

strTagName
The name of the project tag to be added.
optStrTagType
The data type of the project tag to be added. This parameter accepts only the following values: "Boolean", "Integer", "Real", "String", or "classname".

This parameter is optional; if you do not specify a tag or value, then the default value is "Integer".

optNumArraySize
The array size of the project tag to be added.

This parameter is optional; if you do not specify a tag or value, then the default value is 0.

optStrDescription
A description of the project tag to be added.

This parameter is optional; if you do not specify a tag or value, then the default value is "".

optNumScope
The scope of the project tag to be added. This parameter accepts only the following values: 0 (Local) or 1 (Server).

This parameter is optional; if you do not specify a tag or value, then the default value is 1.

Returned value

This function returns one of the following possible values:
Value Description
-5 The maximum number of tags (as determined by the project’s target system) has been reached.
-4 A project tag with the specified name already exists 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.

TagsDBAddTag