Function rcl_subscription_content_filter_options_fini

Function Documentation

rcl_ret_t rcl_subscription_content_filter_options_fini(const rcl_subscription_t *subscription, rcl_subscription_content_filter_options_t *options)

Reclaim rcl_subscription_content_filter_options_t structure.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

No

Parameters:
  • subscription[in] the handle to the subscription.

  • options[in] The structure which its resources have to be deallocated.

Returns:

RCL_RET_OK if the memory was successfully freed, or

Returns:

RCL_RET_SUBSCRIPTION_INVALID if subscription is invalid, or

Returns:

RCL_RET_INVALID_ARGUMENT if option is NULL, or if its allocator is invalid and the structure contains initialized memory.