Function rcl_arguments_copy

Function Documentation

rcl_ret_t rcl_arguments_copy(const rcl_arguments_t *args, rcl_arguments_t *args_out)

Copy one arguments structure into another.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

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

  • args_out – [out] A zero-initialized arguments structure to be copied into.

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.