IESP::QueryStatus
The QueryStatus method retrieves the NPP status.
HRESULT STDMETHODCALLTYPE QueryStatus(NETWORKSTATUS*pNetworkStatus);
Parameters
- pNetworkStatus
[out] A pointer to a returned NETWORKSTATUS structure that indicates the current state (capturing, paused, stopped, and so on) of the NPP. The user must allocate and free the memory for the NETWORKSTATUS structure.
Return Values
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 IESP::QueryStatus again. |
Remarks
This method can be called at any time after the CreateNPPInterface 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, allocate the memory required for the NETWORKSTATUS structure and free that memory when the structure is no longer required.
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. |