Function rcl_action_goal_handle_get_status

Function Documentation

rcl_ret_t rcl_action_goal_handle_get_status(const rcl_action_goal_handle_t *goal_handle, rcl_action_goal_state_t *status)

Get the status of a goal.

This is a non-blocking call.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • goal_handle – [in] struct containing the goal and metadata

  • status – [out] a preallocated struct where the goal status is copied

Returns:

RCL_RET_OK if the goal ID was accessed successfully, or

Returns:

RCL_RET_ACTION_GOAL_HANDLE_INVALID if the goal handle is invalid, or

Returns:

RCL_RET_INVALID_ARGUMENT if the status argument is invalid