ham_condition_handle_free()

Updated: May 06, 2022

Free a previously obtained handle to a condition in an entity

Synopsis:

#include <ha/ham.h>

int ham_condition_handle_free( ham_condition_t *chdl );

Arguments:

chdl
The HAM condition handle you want to free.

Library:

libham

Description:

The ham_condition_handle_free() function frees a handle associated with a condition (chdl) and reclaims all storage associated with the given handle.

The handle chdl must be obtained from ham_condition_handle() or ham_condition(). Once a handle is freed, it is no longer available to refer to any condition. The ham_condition_handle_free() call frees storage allocated for the handle itself 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 handle passed to the function isn't valid.

Classification:

QNX Neutrino

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

Caveats:

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