Function rcl_action_cancel_response_fini

• Defined in File types.h

Function Documentation

rcl_ret_t rcl_action_cancel_response_fini(rcl_action_cancel_response_t *cancel_response)

Finalize a rcl_action_cancel_response_t.

After calling, the cancel response message will no longer be valid.

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

Parameters:

cancel_response – [inout] the cancel response message to be deinitialized

Returns:

RCL_RET_OK if the cancel response was deinitialized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.