pips_event_remove_handler()

De-register a handler for the specified event type and provider

Synopsis:

#include <pips/event.h>
int pips_event_remove_handler(const pips_event_type_e type,
                              pips_provider_t *const provider_handle,
                              pips_event_handler_t const handler,
                              void *user_data)

Arguments:

type
A flag indicating the event type for which a handler is being de-registered
provider_handle
A pointer to the provider for which the event handler is being de-registered
handler
A pointer to the callback to de-register
user_data
A pointer to a user data buffer associated with the handler (callback) being de-registered

Library:

pips-client

Description:

This function de-registers the given handler for the specified event type, provider, and user data. This function should be called before deleting the user data to prevent the event handler from being invoked with invalid user data. After the function call, the handler (callback) won't be invoked with the given user data when an event of the specified type is received by the specified provider.

Returns:

EOK
The handler was successfully de-registered
-1
An error occurred while de-registering the handler (errno is set)

Errors:

  • ENODEV: The provider handle is invalid.
  • ENOTTY: The given event type is not supported.
  • ENOENT: The handler is not registered with the provider.
Page updated: