Function rcl_names_and_types_fini

Function Documentation

rcl_ret_t rcl_names_and_types_fini(rcl_names_and_types_t *names_and_types)

Finalize a rcl_names_and_types_t object.

The object is populated when given to one of the rcl_get_*_names_and_types() functions. This function reclaims any resources allocated during population.

The names_and_types parameter must not be NULL, and must point to an already allocated rcl_names_and_types_t struct that was previously passed to a successful rcl_get_*_names_and_types() function call.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

names_and_types – [inout] struct to be finalized

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.