system.vision.showConfirm

Backwards Compatibility

This function replaces system.gui.confirm. 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 a confirmation dialog box to the user with Yes and No options, and a custom message.

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

Parameters

Type	Parameter	Description
String	message	The message to show in the confirmation dialog.
String	title	The title for the confirmation dialog. [optional]
Boolean	allowCancel	Show a cancel button in the dialog. [optional]

Returns

Boolean - True if the user selected Yes; false if the user selected No. None if the user selected Cancel.

Scope

Vision Client

Code Examples

Example #1

# By using the confirm function in an if statement, we can let the user confirm an action. 
# In this case, we shut down the plant if the user confirms it, otherwise, we don't do anything.
  
if system.vision.showConfirm("Are you sure you want to shutdown the plant?", "Really Shutdown?"):
   system.db.runUpdateQuery("UPDATE ControlTable SET Shutdown=1")