Logo
UNICENS V2.1.0-3491
User Manual and API Reference
#define UCS_TR_ERROR

Trace macro to capture trace error events.

This macro is used to enable the capturing of trace error events. The macro must be mapped onto a user-defined function. To disable the trace error events, the macro must not be defined. The mapped user-defined function must adhere to the following function signature.

void (*Ucs_TraceCb_t)(void * ucs_user_ptr, const char module_str[], const char entry_str[], uint16_t vargs_cnt, ...);

  • ucs_user_ptr
    Reference to the User argument
  • module_str
    The name of the software module that has posted the trace
  • entry_str
    The trace entry as formatted string
  • vargs_cnt
    Number of trace arguments which will be passed within the variable argument list
  • [...]
    Variable argument list to pass trace arguments
Note
The captured error events can be used for logging and as a first step for debugging unexpected behavior. However, the application must not derive any action when an error is indicated by the trace interface. An application must handle rely on result callback functions and handle "general.error_fptr()".

Example:

extern void App_UcsTraceError(void * ucs_user_ptr,
const char module_str[],
const char entry_str[],
uint16_t vargs_cnt,
...);
#define UCS_TR_ERROR App_UcsTraceError