system.vision.showError

Backwards Compatibility

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

Displays an error-style message box to the user.

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.showError(message, [title])

Parameters

Type	Parameter	Description
String	message	The message to display in an error box. Will accept HTML formatting.
String	title	The title for the error box. [optional]

Returns

Nothing

Scope

Vision Client

Code Examples

Example #1 - Using Error Box

# Turn on compressor #12, but only if the user has the right credentials.
  
if 'Supervisor' in system.vision.getRoles():
    updateQuery = "UPDATE CompressorControl SET running=1 WHERE compNum = 12"
    system.db.runUpdateQuery(updateQuery)
else:
    errorMessage = "Unable to turn on Compressor 12."
    errorMessage += " You don't have proper security privileges."
    system.vision.showError(errorMessage)