Function rcl_action_goal_status_array_fini

• Defined in File types.h

Function Documentation

rcl_ret_t rcl_action_goal_status_array_fini(rcl_action_goal_status_array_t *status_array)

Finalize a rcl_action_goal_status_array_t.

After calling, the goal status array message will no longer be valid.

Attribute	Adherence
Allocates Memory	Yes
Thread-Safe	No
Uses Atomics	No
Lock-Free	Yes

Parameters:

status_array – [inout] the goal status array message to be deinitialized

Returns:

RCL_RET_OK if the goal status array was deinitialized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.