Function rcl_logging_rosout_init

Defined in File logging_rosout.h

Function Documentation

rcl_ret_t rcl_logging_rosout_init(const rcl_allocator_t *allocator)

Initializes the rcl_logging_rosout features.

Calling this will initialize the rcl_logging_rosout features. This function must be called before any other rcl_logging_rosout_* functions can be called.

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

Parameters:: allocator – [in] The allocator used for metadata related to the rcl_logging_rosout features
Returns:: RCL_RET_OK if the rcl_logging_rosout features are successfully initialized, or
Returns:: RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or
Returns:: RCL_RET_BAD_ALLOC if allocating memory failed, or
Returns:: RCL_RET_ERROR if an unspecified error occurs.