Versions Compared

Key

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


Panel
titleDescription

Sets the connection mode for the client sessionClient. Normally a client Client runs in mode 3, which is read-write. You may wish to change this to mode 2, which is read-only, which will only allow reading and subscribing to tagsTags, and running SELECT queries. Tag writes and INSERT / UPDATE / DELETE queries will not function. You can also set the connection mode to mode 1, which is disconnected, all tag Tag and query features will not work.

Client permissions restrictions


Panel
titleSyntax

system.util.setConnectionMode(mode)

  • Parameters

Integer mode - The new connection mode: 1 = Disconnected, 2 = Read-only, 3 = Read/Write.

  • Returns

Nothing

  • Scope

Vision Client

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet
# This example, which could go in a project's startup script, checks the current username 
# and sets the connection mode to read-only if it is the "guest" user.
 
username = system.security.getUsername()
if "guest" == username.lower():
   # Set "guest" user to read-only mode.
   system.util.setConnectionMode(2)
else:
   system.util.setConnectionMode(3)
Panel
titleKeywords

system util setConnectionMode, util.setConnectionMode