Function rcl_action_get_goal_status_array

• Defined in File action_server.h

Function Documentation

rcl_ret_t rcl_action_get_goal_status_array(const rcl_action_server_t *action_server, rcl_action_goal_status_array_t *status_message)

Get a status array message for accepted goals associated with an action server.

The provided status_message should be zero-initialized with rcl_action_get_zero_initialized_goal_status_array() before calling this function.

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

Parameters:

• action_server – [in] handle to the action server that will publish the status message

• status_message – [out] an action_msgs/StatusArray ROS message

Returns:

RCL_RET_OK if the response was sent successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ACTION_SERVER_INVALID if the action server is invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.