IDelaydC::GetControlState method

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

Syntax

HRESULT STDMETHODCALLTYPE GetControlState(
  [out] BOOL *IsRunnning,
  [out] 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 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
NMERR_NOT_CONNECTED
The NPP is not connected to the network. Call IDelaydC::Connect to connect the NPP to the network.
NMERR_NOT_DELAYED
The NPP is connected to the network but not with the IDelaydC::Connect method.

Remarks

This method can be called any time the NPP is connected to the network by using the IDelaydC interface. 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.

The methods used to start, pause, and, stop the capture are listed in the See Also list below.

Requirements

Requirement Value
Minimum supported client
Windows 2000 Professional [desktop apps only]
Minimum supported server
Windows 2000 Server [desktop apps only]
Header
Netmon.h
DLL
Ndisnpp.dll;
Rmtnpp.dll

See also

IDelaydC

IDelaydC::Connect

IDelaydC::Pause

IDelaydC::Start

IDelaydC::Stop