NAME

omni::application::set_return_code

A function of omni::application

#include <omni/application.hpp>
void omni::application::set_return_code(int return_code)


SYNOPSIS

Sets the value returned from an omni::application::run function or the exit status passed if omni::application::stop is called.

top

DESCRIPTION

The return value of the omni::application::run functions can be explicitly set via set_return_code as well this function set the exit status code returned should omni::application::stop be called.

top

PARAMETERS top

return_code - The integer value to return.

RETURN VALUES

No return value.

top

ERRORS

No errors specific to this context.

top

CONSIDERATIONS

This function will only have an effect if you have explicitly called one of the omni::application::run functions to block the main thread until program completion or explicitly call omni::application::stop.

top

PLATFORM SPECIFIC

Nothing platform specific to account for.

top

NOTES

No additional notes.

top

EXAMPLE

Currently no examples.

Visit the examples page for more.

top