= !GetExitCode =

{{{
int CForm::GetExitCode(void)
}}}

== Parameters ==

None

== Return Value ==

Returns the currently set exit code value or FORM_EXIT_CODE_KEEP_RUNNING if no exit code was set.

== Remarks ==

GetExitCode may be used after a !ExitWithCode call has been performed to determine the exit value that will be returned when the FORM_RUN ends. This would usually only be useful during a form done event.

== Example ==

{{{
// m_pForm is a pointer already set for the form we want to end
if(m_pForm->GetExitCode() == 123)
{
   DEBUG_MSG("Exit code is 123\n");
}
}}}

{{{
if(m_pForm->GetExitCode() == FORM_EXIT_CODE_KEEP_RUNNING)
{
   DEBUG_MSG("An exit code has not been set\n");
}
}}}

== See Also ==

 * [wiki:ExitWithCode ExitWithCode]