ExitWithCode

void CForm::ExitWithCode(int nCode)

Parameters

• nCode = return value FORM_RUN will return

Return Value

No return value

Remarks

ExitWithCode cannot exit the form immediately but sets an internal flag value to cause the Form to exit upon the next iteration of the form run loop. If a form done event is specified it will be called just before the form exit with flag FORM_DONE_EVENT_EXTERNAL. This is to allow the form done event to know that the form was ended by code rather than a user action upon the form. The form done event may call GetExitCode to determine what the return code will be. The form done event may return zero to cancel the form exit.

Example

// m_pForm is a pointer already set for the form we want to end
m_pForm->ExitWithCode(FORM_RESULT_ENTERED);

See Also

• GetExitCode
• FORM_DONE_EVENT_EXTERNAL