system.vision.showPasswordInput

Backwards Compatibility

This function replaces system.gui.passwordBox. 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

Pops up a special input box that uses a password field, so the text isn't echoed back in clear-text to the user. Returns the text they entered, or None if they canceled the dialog box.

note

This function is available on secondary desktops via the system.vision.desktop function. See the Multi-Monitor Clients page for more details on secondary desktops.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.showPasswordInput(message, [title], [echoChar])

Parameters

Type	Parameter	Description
String	message	The message for the password prompt. Will accept HTML formatting.
String	title	A title for the password prompt. [optional]
String	echoChar	A custom echo character. Defaults to: * [optional]

Returns

String - The password that was entered, or None if the prompt was canceled.

Scope

Vision Client

Code Examples

Example #1

# This example prompts a user for a password before opening the 'Admin' screen.
  
password = system.vision.showPasswordInput("Please enter the password.")
if password == "open sesame":
   system.vision.openWindow("Admin")