IRTC::QueryStatus method

The QueryStatus method retrieves the status of the NPP.

Syntax

HRESULT STDMETHODCALLTYPE QueryStatus(
  [out] NETWORKSTATUS *pNetworkStatus
);

Parameters

pNetworkStatus [out]

Pointer to a returned NETWORKSTATUS structure that indicates the current state (capturing, paused, stopped, and so on) of the NPP. It is the application's responsibility to allocate and free the memory for the NETWORKSTATUS structure.

Return value

If the method is successful, the return value is NMERR_SUCCESS.

If the method is unsuccessful, the return value is the following error code:

Return code Description
NMERR_INVALID_PARAMETER
The pNetworkStatus parameter is not pointing to a valid NETWORKSTATUS structure. Allocate memory for this structure and call IRTC::QueryStatus again.

Remarks

This method can be called at any time after the CreateNPPInterface method is called. You can call this method to see if the NPP is connected to the network, to find out the status of the current capture, and to see if any triggers are pending. Before calling this method, however, you must allocate the memory needed for the NETWORKSTATUS structure and free that memory when the structure is no longer needed.

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

IRTC

CreateNPPInterface

NETWORKSTATUS