Function rclc_action_send_cancel_request

Function Documentation

rcl_ret_t rclc_action_send_cancel_request(rclc_action_goal_handle_t *goal_handle)

Send a cancel request for a goal to an action server.

  • Attribute

    Adherence

    Allocates Memory

    Yes

    Thread-Safe

    No

    Uses Atomics

    No

    Lock-Free

    No

Parameters:

goal_handle[in] goal handle to be cancelled

Returns:

RCL_RET_OK if successful

Returns:

RCL_ERROR (or other error code) if an error has occurred