Function rcl_arguments_fini

Function Documentation

rcl_ret_t rcl_arguments_fini(rcl_arguments_t *args)

Reclaim resources held inside rcl_arguments_t structure.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

args – [in] The structure to be deallocated.

Returns:

RCL_RET_OK if the memory was successfully freed, or

Returns:

RCL_RET_INVALID_ARGUMENT if any function arguments are invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.