IRTC::GetConversationStatistics method

Article
04/27/2021

The GetConversationStatistics method retrieves session and station information about the current capture.

Syntax

HRESULT STDMETHODCALLTYPE GetConversationStatistics(
  [out] DWORD          *nSessions,
  [out] LPSESSIONSTATS lpSessionStats,
  [out] DWORD          *nStations,
  [out] LPSTATIONSTATS lpStationStats,
  [in]  BOOL           fClearAfterReading
);

Parameters

nSessions [out]: Pointer to a DWORD that contains the number of sessions recorded for the current capture.
lpSessionStats [out]: Pointer to a SESSIONSTATS structure.
nStations [out]: Pointer to a DWORD that contains the number of stations recorded for the current capture.
lpStationStats [out]: Pointer to a STATIONSTATS structure.
fClearAfterReading [in]: Flag used to tell Network Monitor to clear out the internal storage of the SESSIONSTATS and STATIONSTATS structures after it retrieves the current information.

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 IRTC::Connect to connect the NPP to the network.
NMERR_NOT_CAPTURING	The NPP is not capturing data. Call IRTC::Start to start the capture.
NMERR_NOT_REALTIME	The NPP is connected to the network but not with the IRTC::Connect method.
NMERR_NO_CONVERSATION_STATS	The configuration for this connection is set to not save conversation statistics. To save conversation statistics, stop the capture, set NoConversationStats = YES in the configuration BLOB, then restart the capture.

Remarks

This method can only be called while you are capturing data; if you call this method while the current capture is paused, the method will not succeed. To start a capture, call the IRTC::Start method.

To retrieve other types of statistics, call the IRTC::GetTotalStatistics 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