TagsDBGetNextTag

This function returns the name of the next tag in the tags database, after the function TagsDBGetFirstTag has been executed to get the first tag. It acts like an array pointer, with the array being the tags database, and it may be used to generate a list of tags in the tags database or to process the tags one at a time, depending on how you write your script.

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

Syntax

  TagsDBGetNextTag()  
Web Studio Help ons tagsdb tagsdbgetnexttag.xml d438231e113 TagsDBGetNextTag

This function has no parameters.

Returned value

If this function is executed succesfully, then it returns the name of the next tag. Otherwise, it returns one of the following possible values:
Value Description
-3 No tag found; at end of 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 TagsDBGetFirstTag and TagsDBGetNextTag 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.

TagsDBGetNextTag