This function is used in Python Scripting.


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.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.


system.gui.passwordBox(message, [title], [echoChar])

  • Parameters

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
Code Snippet
# This example prompts a user for a password before opening the 'Admin' screen.
password = system.gui.passwordBox("Please enter the password.")
if password == "open sesame":

system gui passwordBox, gui.passwordBox