Function rcl_init_options_fini
Defined in File init_options.h
Function Documentation
-
rcl_ret_t rcl_init_options_fini(rcl_init_options_t *init_options)
Finalize the given init_options.
The given init_options must be non-
NULL
and valid, i.e. had rcl_init_options_init() called on it but not this function yet.Attribute
Adherence
Allocates Memory
Yes
Thread-Safe
No
Uses Atomics
Yes
Lock-Free
Yes
- Parameters:
init_options – [inout] object to be setup
- Returns:
RCL_RET_OK if setup is successful, or
- Returns:
RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
- Returns:
RCL_RET_ERROR if an unspecified error occurs.