system.vision.getClientId

Backwards Compatibility

This function replaces system.util.getClientId. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Returns a hex-string that represents a number unique to the running Client's session. You are guaranteed that this number is unique between all running Clients.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.getClientId()

Parameters

Nothing

Returns

String - A special code representing the Client's session in a unique way.

Scope

Vision Client

Code Examples

Example #1

# This code prints the current Client's id to the debug console.
id = system.vision.getClientId()
print id