Function rcl_init_options_get_rmw_init_options
Defined in File init_options.h
Function Documentation
-
rmw_init_options_t *rcl_init_options_get_rmw_init_options(rcl_init_options_t *init_options)
Return the rmw init options which are stored internally.
This function can fail and return
NULL
if:init_options is NULL
init_options is invalid, e.g. init_options->impl is NULL
If NULL is returned an error message will have been set.
Attribute
Adherence
Allocates Memory
No
Thread-Safe
No
Uses Atomics
Yes
Lock-Free
Yes
- Parameters:
init_options – [in] object from which the rmw init options should be retrieved
- Returns:
pointer to the the rcl init options, or
- Returns:
NULL
if there was an error