IStats::GetConversationStatistics method
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]
-
A pointer to a DWORD that contains the number of sessions recorded for the current capture.
-
lpSessionStats [out]
-
A pointer to a SESSIONSTATS structure.
-
nStations [out]
-
A pointer to a DWORD that contains the number of stations recorded for the current capture.
-
lpStationStats [out]
-
A pointer to a STATIONSTATS structure.
-
fClearAfterReading [in]
-
Flag used to instruct Network Monitor to clear the internal storage of the SESSIONSTATS and STATIONSTATS structures after the current data 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 |
|---|---|
|
The NPP is not connected to the network. Call IStats::Connect to connect the NPP to the network. |
|
The NPP is not capturing data. Call IStats::Start to start the capture. |
|
The NPP is connected to the network, but not with the IStats::Connect method. |
|
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, and then restart the capture. |
Remarks
This method can be called only while data capture is in progress; when the current capture is paused, a call to this method will not succeed.
To start a capture, call the IStats::Start method. To retrieve other types of statistics, call IStats::GetTotalStatistics.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 2000 Professional [desktop apps only] |
| Minimum supported server |
Windows 2000 Server [desktop apps only] |
| Header |
|
| DLL |
|