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

Developer

API Reference

IBTDUNGW_GETREPORT()

Brew Release
Brew MP 1.0.2
See Also
IBTDuNGW_OnReportUpdate IBTDuNGW_SetReportConfig IBTDuNGW_GetReportConfig
Description
Retrieves the statistic report. The implementation may allow the caller to retrieve statistics like throughput, total data transmitted, total data received. The format of the report string is defined by the interface implementation.
Params
_pif
[in]:
The object.
report
[in]:
Pointer to a buffer to hold the report string.
reportLen
[in]:
Length of the report buffer
reportLenReq
[out]:
Place holder for length of buffer required to read the entire string. Return
AEE_SUCCESS
[]:
If the size of the input buffer is smaller than the the size required to return the entire report string, partial string will be returned and it will be NUL terminated. The app can allocate the required buffer size and call this API again. Another appropriate error code if operation was not successful.
Interface
Prototype
  •    AEEResult IBTDuNGW_GetReport(IBTDuNGW*  _pif,
                                    char*      report,
                                    int        reportLen,
                                    int*       reportLenReq)