Function rcl_node_options_fini

Function Documentation

rcl_ret_t rcl_node_options_fini(rcl_node_options_t *options)

Finalize the given node_options.

The given node_options must be non-NULL and valid, i.e. had rcl_node_get_default_options() called on it but not this function yet.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

Yes

Lock-Free

Yes

Parameters:

options – [inout] object to be finalized

Returns:

RCL_RET_OK if setup is successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.