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. |
Refer to the RunUserInterface function reference for an example of how to use this and other user interface management functions.
Parameters
Input | ||
Name | Type | Description |
returnCode | int | 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 | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred. |
Additional Information
Library: User Interface Library
Include file: userint.h
LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later
Example
Refer to userint\events.cws for an example of using the QuitUserInterface function.