system.tag.writeBlocking
This function is used in Python Scripting.
Description​
Writes values to tags at the given paths. This function will "block" until the write operation is complete or times out. Meaning, execution of the calling script will pause until this function finishes. This is useful in cases where the tag write must complete before further lines in the same script should execute.
Client Permission Restrictions​
Permission Type: Tag Editing
Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.
Syntax​
system.tag.writeBlocking(tagPaths, values, [timeout])
Parameters​
Type | Parameter | Description |
---|---|---|
List | tagPaths | A List of tag paths to write to. If no property is specified in a tag path, the Value property is assumed. |
List | values | A list of values to write to the specified tag paths. |
Integer | timeout | How long to wait in milliseconds before the write operation times out. This parameter is optional and defaults to 45000 milliseconds if not specified. [optional] |
Returns​
List - A List of QualityCode objects, one for each Tag path. See Scripting Object Reference.
Scope​
Gateway, Vision Client, Perspective Session
Code Examples​
# Create a list with the tag paths to be updated.
paths = ["[default]Folder/Tag_A","[default]Folder/Tag_B"]
# Create a list with the update values, one value for each path.
values = [1,2]
# Execute the write operation.
system.tag.writeBlocking(paths, values)