Share via


IStats::GetControlState

The GetControlState method retrieves the state of the capture, which indicates if the capture is running or paused.

HRESULT STDMETHODCALLTYPE GetControlState(BOOL*IsRunnning,
BOOL*IsPaused);

Parameters

  • IsRunnning
    [out] Indicator that the current capture is running, including if the capture is paused.
  • IsPaused
    [out] Indicator that the current capture is paused.

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_NOT_CONNECTED The NPP is not connected to the network. Call IStats::Connect 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

This method can be called any time the NPP is connected to the network. You can use this method to find out if a capture is running, if the capture is paused, or if the capture has been stopped but the NPP is not disconnected.

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::Pause, IStatsC::Start, IStatsC::Stop