Skip to main content
Version: Deprecated Pages

system.tag.writeToTag

This function is used in Python Scripting.

Description

Writes a value to a tag. If suppressErrors is true, error messages on failed writes will not be shown.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.tag.write(tagPath, value, [suppressErrors])

  • Parameters
    • String tagPath - The path of the tag to write to.
    • Object value - The value to write.
    • Boolean suppressErrors - A flag indicating whether or not to suppress errors. [optional]
  • Returns
    • int - 0 if the write failed immediately, 1 if it succeeded immediately, and 2 if it is pending.
  • Scope
    • All

Code Examples

Code Snippet
# This code would go on a property change event for a numeric text field to calculate and write a value to a tag.

if event.propertyName == intValue:
calcValue = event.newValue * 2.5
system.tag.writeToTag("Tanks/tankHiSP",calcValue)