Function rcl_init_options_get_domain_id

Defined in File init_options.h

Function Documentation

rcl_ret_t rcl_init_options_get_domain_id(const rcl_init_options_t *init_options, size_t *domain_id)

Return the domain_id stored in the init options.

Get the domain id from the specified rcl_init_options_t object.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	Yes
Uses Atomics	No
Lock-Free	Yes

Parameters:

init_options – [in] object from which the domain id should be retrieved.
domain_id – [out] domain id to be set in init_options object.

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid.