Developer

API Reference

ILOGGER_PutMsg()

Brew Release
Brew MP 1.0.2
Description
This function is called to send a predefined binary message and allows fast logging due to the limited formatting required and the fixed size of the outgoing log message.
The outgoing binary message's data of type structure AEELogBinMsgType, which is defined in AEELoggerTypes.h.
Parameters
  • pMe
    []:
    Pointer to the ILogger object
  • bucket
    []:
    Bucket to place item
  • pszFileName
    []:
    ASCII NULL terminated name of file calling this function
  • nLineNum
    []:
    Line number in file where it was called
  • pszMsg
    []:
    ASCII NULL terminated text message nNumArgs length of the args array
  • args
    []:
    array containing uint32 arguments
Interface
ILOGGER
Prototype
   int ILOGGER_PutMsg( ILogger *pMe, 
                       AEELogBucketType bucket, 
                       const char *pszFileName, 
                       uint16 nLineNum, 
                       const char *pszMsg, 
                       uint8  nNumArgs,
                       uint32 args[ MAX_LOG_TYPE_BIN_MSG_ARGS ] )
Return
SUCCESS: Log sent successfully EBADPARM: Invalid pointer to pszMsg or nNumArgs too large 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
Comment
None
  • Follow