ham_action_fail

Add an execute action to an action, that will be executed if the corresponding action fails

Synopsis:

#include <ha/ham.h>

int ham_action_fail_execute(
                 ham_action_t *ahdl,
                 const char *aname, 
                 const char *path, 
                 unsigned flags);

Arguments:

ahdl: The HAM action handle.
aname: The action fail item to add to the action handle.
path: The FULL path to the executable along with all parameters to be passed to it.
flags: The flags indicating the conditions that will execute the function when triggered.

Library:

libham

Description:

The ham_action_fail_execute() function adds an action fail item (aname) to the specified action. The action will execute an external program or command specified by path. The path parameter must contain the FULL path to the executable along with all parameters to be passed to it. along with all parameters to be passed to it. If either the pathname or the arguments contain spaces that need to be passed on literally to the spawn call, they need to be quoted. As long as the subcomponents within the path arguments are quoted, using either of the following methods:

\'path with space\'

\"path with space\",

the following is allowed:

"\'path with space\' arg1 arg2 \"arg3 with space\"".

This would be parsed as

"path with space" -> path

arg1 = arg1

arg2 = arg2

arg3 = "arg3 with space".

The command line is in turn passed onto a spawn() command by the HAM to create a new process that will execute the command.

The handle (ahdl) is obtained either:

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

Returns:

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

Errors:

EBADF: Couldn't connect to the HAM.
EINVAL: The name given in aname is invalid (e.g., it contains the “/” character) or is NULL.
The connection to the HAM is invalid. This happens when the process that opened the connection (using ham_connect()) and the process that's calling ham_action_execute() aren't the same.
ENAMETOOLONG: The name given (in aname) is too long, i.e. it exceeds _POSIX_PATH_MAX (defined in <limits.h>). Note that the combined length of an entity/condition/action name is also limited by _POSIX_PATH_MAX.
ENOENT: There's no entity or condition specified by the given handle (ahdl).
ENOMEM: Not enough memory to create a new handle.

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

Classification:

QNX Neutrino

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