ham_entity_handle_free()

Updated: May 06, 2022

Free a previously obtained handle to an entity

Synopsis:

#include <ha/ham.h>

int ham_entity_handle_free( ham_entity_t *ehdl );

Arguments:

ehdl
The HAM entity handle to free.

Library:

libham

Description:

The ham_entity_handle_free() function frees a handle associated with an entity (ehdl) and reclaims all storage associated with the given handle.

The handle (ehdl) must be obtained from ham_entity_handle(), ham_attach(), or ham_attach_self(). Once a handle is freed, it is no longer available to refer to any condition. The ham_entity_handle_free() call frees storage allocated for the handle but does not remove the condition itself, which is in the HAM.

Returns:

0
Success.
-1
An error occurred (errno is set).

Errors:

EINVAL
The name given in ename isn't valid.

Classification:

QNX Neutrino

Safety:  
Cancellation point No
Interrupt handler No
Signal handler No
Thread Yes

Caveats:

The ham_entity_handle_free() function frees storage related only to the handle in the client — it doesn't remove the corresponding entity.