Share via


IStats::Pause

The Pause method temporarily stops the current capture.

HRESULT STDMETHODCALLTYPE Pause();

Parameters

This method has no parameters.

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_CAPTURE_PAUSED The capture is already paused.
NMERR_NOT_CAPTURING The NPP is not capturing data. Call the IStats::Start method to start the capture.
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.

Remarks

While the capture is paused, new frames are not captured until a call to the IStats::Resume method restarts the capture.

When you use the IStats::Pause and IStats::Resume methods to control the capture, Network Monitor continues to add conversation statistics whenever the capture is running.

To restart the capture call IStats::Resume. To stop the capture, call IStats::Stop.

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::Resume, IStats::Start, IStats::Stop