QuitUserInterface

int QuitUserInterface (int returnCode);

Purpose

Causes RunUserInterface to return with a specific return code and terminates event processing. Call QuitUserInterface only from within a callback function invoked during execution of RunUserInterface.

Note    QuitUserInterface causes the most recent active call to RunUserInteface to return after all currently executing callbacks have exited.

Parameters

Input
Name Type Description
returnCode integer Value that the current call to RunUserInterface returns when it terminates. Use this value as a flag to pass information back through RunUserInterface.

Pass a value greater than or equal to zero.

Return Value

Name Type Description
status integer Return value indicating whether the function was successful. A negative number indicates that an error occurred.

Code Error Message String
xx Success