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

Developer

API Reference

ILOGGER_SETPARAM()

Brew Release
Brew MP 1.0.2
See Also
AEELogParamType Documentation for AEELoggerFile and ILogger interfaces
Description
This function is called to configure the performance and behavior of the ILogger interface
Supported Parameters: Depends on the current implementation's support, see parameter documentation above.
Params
pMe
[]:
Pointer to the ILogger object
pType
[]:
Parameter to modify
param
[]:
New settings parameter
pParam
[]:
Pointer to new settings parameter
Interface
  • ILOGGER
Prototype
  •    int ILOGGER_SetParam( ILogger *po, AEELogParamType pType, uint32 param, void* pParam )
    
Return
  • SUCCESS: Parameter handled successfully EUNSUPPORTED: Parameter type or option not supported EFAILED: General failure, option not handled successfully EBADPARM: NULL parameter pointer
    -- The following log codes only apply to file logging

    EFILENOEXISTS: Output log file is closed EFILEEXISTS: Output log file is open
    -- The following log codes only apply to serial logging

    SUCCESS: Parameter handled successfully or successfully opened the port EFAILED: Parameter type or option not supported, or general failure AEESIO_EINPROGRESS: Open in progress use AEE_LOG_PARAM_SIO_GET_STATUS to check port status later or wait for callback AEESIO_ENOSUCHPORT: The asked port name is not supported AEESIO_EINUSE: Port is currently used by some other entity
    -- See OEM specific header files for further return values
Side Effect
  • None
Comments
None