Tags Database functions

These functions are used to directly change the values of project tags.

  • ExecuteAlarmAck
    This function acknowledges an active alarm on the specified tag. The advantage of using this function is that if used from the Thin Client, the Alarm task will store the user name and station from which the alarm was acknowledged.
  • ForceTagChange
    Forces the database to write a value to a tag and trigger events as if the tag changed, even if the new value is equal to the old value.
  • GetAlarmCount
    This function gets the number of active alarms.
  • GetAlarmInfo
    This function gets information about an active alarm.
  • GetTagValue
    Gets the value of the specified tag from the project tags database.
  • SetTagValue
    Sets the value of the specified tag in the project tags database.
  • TagsDBAddClass
    This function adds a new class to the tags database during run time.
  • TagsDBAddClassMember
    This function adds a new class member to an existing class during run time.
  • TagsDBAddTag
    This function adds a new project tag to the tags database during run time.
  • TagsDBBeginEdit
    This function locks the tags database for editing during run time. You must call this function before you call any other Tags Database functions to add or remove project tags or configure tag properties.
  • TagsDBEndEdit
    This function finishes changes made by other Tags Database functions and releases the database so that normal run-time execution may resume.
  • TagsDBGetAlarm
    This function gets the properties of an alarm condition during run time.
  • TagsDBGetClassMember
    This function gets the data type or description of a specified class member during run time.
  • TagsDBGetClassMemberCount
    This function gets a count of the members in a specified class.
  • 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.
  • TagsDBGetFirstClassMember
    This function returns the name of the first member in a specified class. It acts like an array pointer, with the array being the class members, and it may be used in coordination with the function TagsDBGetNextClassMember either to generate a list of members in the class or to process the class members one at a time, depending on how you write your script.
  • TagsDBGetFirstTag
    This function returns the name of the first project tag 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 TagsDBGetNextTag either 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.
  • TagsDBGetNextClass
    This function returns the name of the next class in the tags database, after the function TagsDBGetFirstClass has been executed to get the first class. It acts like an array pointer, with the array being the tags database, and it may be used 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.
  • TagsDBGetNextClassMember
    This function returns the name of the next member in the specified class, after the function TagsDBGetFirstClassMember has been executed to get the first member. It acts like an array pointer, with the array being the members of the class, and it may be used to generate a list of classes members or to process the class members one at a time, depending on how you write your script.
  • 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.
  • TagsDBGetTagCount
    This function gets a count of the project tags in the tags database.
  • TagsDBGetTagProperty
    This function gets the value of a specified tag property during run time. Tag properties are the metadata on project tags, such as tag name, array size, data type, description, scope, and so on. In some cases, calling this function is the same as using tag fields (e.g., tagname->property).
  • TagsDBGetTrend
    This function determines the trend group to which a project tag is assigned.
  • TagsDBRemoveAlarm
    This function removes an alarm condition from a project tag during run time.
  • TagsDBRemoveClass
    This function removes an existing class from the tags database during run time.
  • TagsDBRemoveClassMember
    This function removes an existing class member from a specified class during run time.
  • TagsDBRemoveTag
    This function removes an existing project tag from the tags database during run time.
  • TagsDBRemoveTrend
    This function removes a project tag from its trend group during run time.
  • TagsDBSetAlarm
    This function sets the properties of an alarm condition during run time.
  • TagsDBSetTagProperty
    This function sets the value of a specified tag property during run time. Tag properties are the metadata on project tags, such as tag name, array size, data type, description, scope, and so on.
  • TagsDBSetTrend
    This function assigns a project tag to a trend group.
InduSoft Web Studio -Technical Reference

Tags Database functions