Share via


IESP::Pause

The Pause method pauses the current capture.

HRESULT STDMETHODCALLTYPE Pause(LPSTATISTICSlpStats);

Parameters

  • lpStats
    Obsolete.

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 IESP::Start to start the capture.
NMERR_NOT_CONNECTED The NPP is not connected to the network. Call IESP::Connect to connect the NPP to the network.
NMERR_NOT_ESP The NPP is connected to the network but not with the IESP::Connect method.

Remarks

While the capture is in a paused state, new data is not added to the current capture file until you call the IESP::Resume method to restart the capture. When Pause and Resume are used to stop and restart the capture, all captured information is put in the same capture file.

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

To restart the capture, call IESP::Resume. To stop the capture, call IESP::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

IESP::Connect, IESP::Resume, IESP::Start, IESP::Stop