Share via

IESP::Start

  • Article

The Start method starts a capture.

HRESULT STDMETHODCALLTYPE Start(char*pFileName);

Parameters

  • pFileName
    [out] Pointer to the name of the capture file used to store the network data. Be sure to cache this file name if it is needed for future reference.

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 paused and must be stopped before it can be restarted. Call IESP::Stop to stop the capture.
NMERR_CAPTURING The capture is already started.
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

The location of the capture file is specified in the Windows registry, but you can use Network Monitor to change the directory location.

When you restart the capture by using the IESP::Start and IESP::Stop methods, you must call the IESP::Configure method to reconfigure the connection each time you call IESP::Start to restart capturing data. When you start and stop the capture with these three methods, a new capture file is created each time the capture is started.

Note    You can also start and stop the capture by using the IESP::Pause and IESP::Resume methods. When these two methods are used, the captured data is stored in the same capture file.

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::Configure, IESP::Connect, IESP::Pause, IESP::Resume, IESP::Stop