API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ILOGGER_PRINTF()

Brew Release
Brew MP 1.0.2
Description
This function is called to send a formatted ASCII text message.
Since this routine is a MACRO that allows variable arguments, it must be called as follows:
   ILOGGER_Printf( pMe->m_pILogger, 
                   ( pMe->m_pILogger, 
                   USER_BUCKET1,
                   __FILE__, 
                   (uint16)__LINE__, 
                   "msg",
                   args ) );
Notice that the second argument is actually multiple arguments in parentheses, and args can be multiple comma-separated values
Params
pMe
[]:
Pointer to the ILogger object
bucket
[]:
Bucket to place item
pszFileName
[]:
Name of file calling this function
nLineNum
[]:
Line number in file where it was called
pszFormat
[]:
ASCII text string similar to a printf format string ...: Format string arguments
Interface
  • ILOGGER
Prototype
  •    int ILOGGER_Printf( ILogger *pMe, 
                           AEELogBucketType bucket, 
                           const char *pszFileName, 
                           uint16 nLineNum, 
                           const char *pszFormat, 
                           ... );
    
Return
  • SUCCESS: Log sent successfully EBADPARM: Invalid pointer to pszFormat EUNSUPPORTED: Log item filtered ENOMEMORY: Unable to allocate required memory EFAILED: Log not sent
    -- The following log codes only apply to file logging

    EFSFULL: Not enough space in log file for this packet EFILENOEXISTS: Output log file is closed
Side Effect
  • None
Comments
None