Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 1.22 KB

Exit.md

File metadata and controls

50 lines (31 loc) · 1.22 KB

Exit

Forces the current plugin to terminate and continues processing with the next plugin.

Syntax

Exit,<Message>[,NOWARN]

Arguments

Argument Description
Message Text that will be displayed and written to the log citing the reason for the Exit.

Flags

Flag Description
NOWARN (Optional) Suppresses the Warning state in the log.

Remarks

Default behavior is to log the Exit action as a warning. If this is not a critical event you can override this behavior with the NOWARN flag.

If the plugin has defined the System,OnPluginExit directive the command will be processed before the plugin exits. This allows the developer to perform further logging and cleanup based on the reason for the Exit.

Related

System,OnScriptExit

Examples

Example 1

Stop processing the current plugin and log a warning.

Exit,"Unable to continue because the file was not found."

Example 2

Stop processing the current plugin, but don't log a warning.

// No need to warn the user as the action is intended to prevent further processing.
Exit,"The application is already configured.",NOWARN