Share via

IStats::GetTotalStatistics

  • Article

The GetTotalStatistics method retrieves the total statistics for the current capture.

HRESULT STDMETHODCALLTYPE GetTotalStatistics(LPSTATISTICSlpStats,
BOOLfClearAfterReading);

Parameters

  • lpStats
    [out] Pointer to a STATISTICSstructure that provides the total statistics for the capture. It is the caller's responsibility to allocate and free the memory used by the STATISTICS structure.
  • fClearAfterReading
    [in] Flag used to tell Network Monitor how to handle the internal storage of the total statistics. A setting of TRUE tells Network Monitor to clear out the internal storage of the total statistics after the current information is retrieved.

Return Values

If the method is successful, the return value is NMERR_SUCCESS.

If the method is unsuccessful, the return value is one of the following error codes:

Return code Description
NMERR_NOT_CONNECTED The NPP is not connected to the network. Call the IStats::Connect method to connect the NPP to the network.
NMERR_NOT_STATS_ONLY The NPP is connected to the network but not with the IStats::Connect method.
NMERR_NOT_CAPTURING The NPP is not capturing data. Call the IStats::Start method to start capturing data.

Remarks

This method returns data only while a capture is in progress, including while the capture is paused.

Network Monitor also stores conversation statistics, which can be retrieved by calling the IStats::GetConversationStatistics method.

Requirements

Client Requires Windows XP, Windows 2000 Professional, or Windows NT Workstation 4.0.
Server Requires Windows Server 2003, Windows 2000 Server, or Windows NT Server 4.0.
Header

Declared in Netmon.h.
DLL Requires Ndisnpp.dll. Requires Rmtnpp.dll.

See Also

IStats::Connect, IStats::GetConversationStatistics, IStats::Start,, STATISTICS