NAME

omni::application::shutdown_handler::detach

A function of omni::application::shutdown_handler

SYNOPSIS

Detach an omni::callback delegate from the application shutdown event.

#include <omni/application.hpp>
void omni::application::shutdown_handler::detach(const omni::callback& shutdown_func)

top

DESCRIPTION

Detaches an omni::callback that was first attached via the omni::application::shutdown_handler::attach function. If the callback was never first attached, this function has no effect.

top

PARAMETERS top

shutdown_func - The omni::callback delegate function to detach.

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.

top

PLATFORM SPECIFIC

Nothing platform specific to account for.

top

NOTES

Calling this function after the shutdown handler has been called will have no effect on the handler since it will have already been called.

top

EXAMPLE

#include <omni/application>

void app_exit()
{
    std::cout << "Application exiting" << std::endl;
}

void app_shutdown()
{
    std::cout << "Application shutting down" << std::endl;
}

void app_run()
{
    std::cout << "Leaving, waiting for CTRL+C" << std::endl;
}

int main(int argc, const char* argv[])
{
    omni::application::exit_handler::attach(&app_exit);
    omni::application::shutdown_handler::attach(&app_shutdown);
    if (argc > 2) {
        omni::application::shutdown_handler::detach(&app_shutdown);
    }
    return omni::application::run(&app_run);
}

Visit the examples page for more.

top