Function rcl_node_options_copy

• Defined in File node_options.h

Function Documentation

rcl_ret_t rcl_node_options_copy(const rcl_node_options_t *options, rcl_node_options_t *options_out)

Copy one options structure into another.

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

Parameters:

• options – [in] The structure to be copied. Its allocator is used to copy memory into the new structure.

• options_out – [out] An options structure containing default values.

Returns:

RCL_RET_OK if the structure was copied successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any function arguments are invalid, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.