Function rcl_logging_configure

• Defined in File logging.h

Function Documentation

rcl_ret_t rcl_logging_configure(const rcl_arguments_t *global_args, const rcl_allocator_t *allocator)

Configure the logging system.

This function should be called during the ROS initialization process. It will add the enabled log output appenders to the root logger.

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

Parameters:

• global_args – [in] The global arguments for the system

• allocator – [in] Used to allocate memory used by the logging system

Returns:

RCL_RET_OK if successful, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ERROR if a general error occurs