Developer

API Reference

LOG_TEXT()

Brew Release
Brew MP 1.0.2
See Also
Description
The macros, LOG_TEXT() and LOG_TEXT_EX() are provided to the developer to quickly output text messages with or without file and line numbers. LOG_TEXT() only ouputs a simple text message, whereas LOG_TEXT_EX(), in addition to the text message, will output the file and line number of where the call occurred.
Parameters
  • inst
    []:
    Pointer to the ILogger object
  • bkt
    []:
    Bucket to place item
  • str
    []:
    Pointer to instance of type
Prototype
#define LOG_TEXT(    inst, bkt, str ) ILOGGER_PutItem( inst, bkt, AEE_LOG_TYPE_TEXT, (uint16)( STRLEN(str) + 1 ), (uint8*)str )

#define LOG_TEXT_EX( inst, bkt, str ) ILOGGER_Printf( inst, ( inst, bkt, __FILE__, (uint16)__LINE__, str ) )
Return
SUCCESS: Log sent successfully EBADPARM: Invalid pointer to pItem or size equal to zero EUNSUPPORTED: Log item filtered ENOMEMORY: Unable to allocate required memory EFAILED: Log not sent
Side Effect
None.
Comment
None.
  • Follow