TagsDBGetFirstClass

This function returns the name of the first class in the tags database. It acts like an array pointer, with the array being the tags database, and it may be used in coordination with the function TagsDBGetNextClass either to generate a list of classes in the tags database or to process the classes one at a time, depending on how you write your script.

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

Syntax

  TagsDBGetFirstClass()
Web Studio Help tagsdb tagsdbgetfirstclass.xml d435482e113 TagsDBGetFirstClass

This function has no parameters.

Returned value

If this function is executed succesfully, then it returns the name of the first class. Otherwise, it returns one of the following possible values:
Value Description
-3 No classes found in the tags database.
-2 Invalid number of parameters.

Notes

This 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.

Also, this function may be called at any time; the function TagsDBBeginEdit does not need to have been executed previously. If that is the case, however, then TagsDBGetFirstClass and TagsDBGetNextClass can only generate a list of classes. They cannot be used, along with with the other Tags Database functions, to edit the classes.

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

Related reference
InduSoft Web Studio -Technical Reference

TagsDBGetFirstClass