Function rcl_subscription_options_fini

Function Documentation

rcl_ret_t rcl_subscription_options_fini(rcl_subscription_options_t *option)

Reclaim resources held inside rcl_subscription_options_t structure.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

No

Parameters:

option – [in] The structure which its resources have to be deallocated.

Returns:

RCL_RET_OK if the memory was successfully freed, or

Returns:

RCL_RET_INVALID_ARGUMENT if option is NULL, or

Returns:

RCL_RET_BAD_ALLOC if deallocating memory fails.