TagsDBRemoveClass

This function removes an existing class from the tags database during run time.

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

Syntax

  TagsDBRemoveClass( strClassName )  
Web Studio Help ns tagsdb tagsdbremoveclass.xml d442431e113 TagsDBRemoveClass

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 (i.e., 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 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.

TagsDBRemoveClass