Skip to main content
Version: 8.1

system.gui.errorBox

This function is used in Python Scripting.

Description​

Displays an error-style message box to the user.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.gui.errorBox(message, [title])

Parameters​

TypeParameterDescription
StringmessageThe message to display in an error box. Will accept HTML formatting.
StringtitleThe 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.security.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.gui.errorBox(errorMessage)

Keywords​

system gui errorBox, gui.errorBox