TagsDBGetNextTag

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

Syntax

TagsDBGetNextTag()

TagsDBGetNextTag ( )

This function has no parameters.

Return value

If this function is executed successfully, it returns the name of the next tag. Otherwise, it returns one of the following possible values:

Notes

This function can be executed only 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 can be called at any time; the TagsDBBeginEdit function does not need to have been executed beforehand. If that is the case, however, then TagsDBGetFirstTag and TagsDBGetNextTag can be used only to generate a list of tags. They cannot be used — along with with the other Tags Database functions — to edit the tags unless TagsDBBeginEdit has been executed.

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