HAM API Reference

Parent topic: HAM API Reference

ham_action_remove()

Updated: October 28, 2024

Remove an action from a condition

Synopsis:

#include <ha/ham.h>

int ham_action_remove( ham_action_t *ahdl,
                       unsigned flags);

Arguments:

ahdl: The HAM action handle to remove.
flags: Currently not used.

Library:

libham

Description:

You use the ham_action_remove() function to remove an action from a condition in a specific entity.

You can obtain the handle (ahdl) either:

from one of the ham_action*() functions that add actions
or:
by calling ham_action_handle() to request a handle to a specific condition.

The flags argument isn't currently used.

Returns:

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

Errors:

EBADF: Couldn't connect to the HAM.
EINVAL: The handle passed is invalid.
ENOENT: There's no action corresponding to the given handle (ahdl).

In addition to the above errors, the HAM returns any error it encounters while servicing this request.

Classification:

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

Parent topic: HAM API Reference