Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: style
Scripting_function


Panel
titleDescription

Retrieves this Client's current connection mode: 3 is read/write, 2 is read-only, and 1 is disconnected.

Client permissions restrictions


Panel
titleSyntax

system.util.getConnectionMode()

  • Parameters

Nothing

  • Returns

Integer - The current connection mode for the clientClient.

  • Scope

Vision Client

Panel
titleCode Examples
Code Block
languagepy
# This code sets a clientClient to read-only after a timeout of 30 seconds.
# Add this code to a clientClient timer script.
 
mode = system.util.getConnectionMode()
if mode == 3 and system.util.getInactivitySeconds() > 30:
	system.util.setConnectionMode(2)
Panel
titleKeywords

system util getConnectionMode, util.getConnectionMode