Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Scripting_function



Panel
titleDescription

Writes a value to a tag. Note that this function writes asynchronously. This means that the function does not wait for the write to occur before returning - the write occurs sometime later on a different thread.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

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, client-only).

  • Returns

int - 0 if the write failed immediately, 1 if it succeeded immediately, and 2 if it is pending.

  • Scope

All



Panel
titleCode Examples


Code Block
languagepy
titleCode 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.write("Tanks/tankHiSP",calcValue)