Versions Compared

Key

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


Scripting_function



Panel
titleDescription

Reads the value of the Tags at the given paths. Will "block" until the read operation is complete or times out. Meaning, execution of the calling script will pause until this function finishes. This useful in cases where the tag read must complete before further lines in the same script should execute. 


Client permissions restrictions



Panel
titleSyntax

system.tag.readBlocking(tagPaths, [timeout])

  • Parameters

List tagPaths - A List of Tag paths to read from. If no property is specified in a path, the Value property is assumed.

Integer timeout - How long to wait in milliseconds before the read operation times out. This parameter is optional, and defaults to 45000 milliseconds if not specified. [optional]

  • Returns

List - A list of QualifiedValue objects corresponding to the Tag paths. See Scripting Object Reference.

  • Scope

Gateway, Vision Client, Perspective Session



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet - Read From Multiple Tags
# Specify the paths.
paths = [
			"[default]Folder/Tag_A",
			"[default]Folder/Tag_B"
		]

# Send the reads off.
values = system.tag.readBlocking(paths)

# Here we can examine each value.
for i in range(len(values)):
	print "Tag at Path: %s\n Had a value of %s" % (paths[i], values[i].value)




Panel
titleKeywords

system tag readBlocking, tag.readBlocking