Function rcl_logging_rosout_remove_sublogger

Function Documentation

rcl_ret_t rcl_logging_rosout_remove_sublogger(const char *logger_name, const char *sublogger_name)

Remove a subordinate logger and cleans up allocated resources.

Calling this will destroy the subordinate logger based on logger_name+RCUTILS_LOGGING_SEPARATOR_STRING+sublogger_name on that node and remove it from the logging system so that no more Log messages are published to this function.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:
  • logger_name[in] a logger_name that has a corresponding rosout publisher on a node

  • sublogger_name[in] a sublogger name

Returns:

RCL_RET_OK if the subordinate logger was finalized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_NOT_FOUND if the sublogger does not exist, or

Returns:

RCL_RET_BAD_ALLOC if allocating memory failed, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.