Skip to main content
Version: 8.1

system.util.exit

This function is used in Python Scripting.

Description​

Exits the running client, as long as the shutdown intercept script doesn't cancel the shutdown event. Set force to true to not give the shutdown intercept script a chance to cancel the exit. Note that this will quit the Client completely. you can use system.security.logout() to return to the login screen.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.util.exit([force])

Parameters​

TypeParameterDescription
BooleanforceIf true (1), the shutdown-intercept script will be skipped. Default is false (0). [optional]

Returns​

Nothing

Scope​

Vision Client

Code Examples​

Example #1
# This code would exit the client after confirming with the user.
if system.gui.confirm("Are you sure you want to exit?"):
system.util.exit()