12.2.1. Logger C-APIs - 5.2 English - 68552

AOCL API Guide (68552)

Document ID
68552
Release Date
2025-12-29
Version
5.2 English

These C-APIs parallel the C++ logging classes and provide basic operations for creating, using, and destroying a logger context.

Enums

enum log_level_t#

Defines available severity levels for C-API logging.

The higher the level, the more severe the event.

Values:

enumerator AUD_LOG_LEVEL_TRACE#
enumerator AUD_LOG_LEVEL_DEBUG#
enumerator AUD_LOG_LEVEL_INFO#
enumerator AUD_LOG_LEVEL_WARN#
enumerator AUD_LOG_LEVEL_ERROR#
enumerator AUD_LOG_LEVEL_FATAL#

Functions

logger_ctx_t *au_logger_create()#

Creates a new logger context for the C-API.

Returns:

A pointer to the newly allocated logger context.

void au_logger_log(logger_ctx_t *logger, const char *message, log_level_t level)#

Logs a message at the specified log level.

Parameters:
  • logger[in] Pointer to the logger context.

  • message[in] Null-terminated string message.

  • level[in] Desired log severity level.

void au_logger_flush(logger_ctx_t *logger)#

Forces any buffered messages to be flushed.

Parameters:

logger[in] Pointer to the logger context.

void au_logger_destroy(logger_ctx_t *logger)#

Destroys the logger context and releases its resources.

Parameters:

logger[in] Pointer to the logger context.