1.2.5.8.17 PPP_StatisticsGet Function

C

bool PPP_StatisticsGet(DRV_HANDLE hMac, PPP_STATISTICS* pStat, bool clear);

Returns

  • true - if the call succeeds

  • false - if no such hMac exists

Description

This function will copy the current value of the PPP statistics to the user supplied data structure

Remarks

This API exists only when the build symbol PPP_ENABLE_STATISTICS != 0

Preconditions

The PPP module must be initialized.

Parameters

hMac - driver handle (obtained by calling TCPIP_MAC_Open/DRV_PPP_MAC_Open)

pStat - address where to store the statistics

clear - if true, the statistics data will be cleared

Example