system.vision.getLocale

Backwards Compatibility

This function replaces system.util.getLocale. 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 the current string representing the user's Locale, such as 'en' for English.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.getLocale()

Parameters

Nothing

Returns

String - String representing the user's Locale, such as 'en' for English.

Scope

Vision Client

Code Examples

Example #1

# print a test if they are using English
locale = system.vision.getLocale()
if locale == "en":
    print "Using English"