IDelaydC::GetTotalStatistics method

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

Syntax

HRESULT STDMETHODCALLTYPE GetTotalStatistics(
  [out] LPSTATISTICS lpStats,
  [in]  BOOL         fClearAfterReading
);

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 value

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 IDelaydC::Connect to connect to the network.
NMERR_NOT_DELAYED
The NPP is connected to the network but not with the IDelaydC::Connect method.
NMERR_NOT_CAPTURING
The NPP is not capturing data. Call IDelaydC::Start to start capturing data.

Remarks

This method returns data only while a capture is in progress; when the capture is paused, calls to this method will not succeed.

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

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Netmon.h
DLL
Ndisnpp.dll;
Rmtnpp.dll

See also

IDelaydC

IDelaydC::Connect

IDelaydC::GetConversationStatistics

IDelaydC::Start

STATISTICS