Function rclc_executor_handle_clear

• Defined in File executor_handle.h

Function Documentation

rcl_ret_t rclc_executor_handle_clear(rclc_executor_handle_t *handle, size_t max_handles)

Resets a rclc_executor_handle_t. Compared to the function rclc_executor_handle_init() only the rclc_executor_handle_t.index and rclc_executor_handle_t.initialized variables are reset to default values.

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

Parameters:

• handle – [inout] a preallocated rclc_executor_handle_t

• max_handles – [in] maximum number of handles

Returns:

RCL_RET_OK if h was cleared successfully

Returns:

RCL_RET_INVALID_ARGUMENT if h is a null pointer