IESP::Configure method

Article
01/07/2021

The Configure method submits configuration information for a capture.

Syntax

HRESULT STDMETHODCALLTYPE Configure(
  [in]  HBLOB hConfigurationBlob,
  [out] HBLOB hErrorBlob
);

Parameters

hConfigurationBlob [in]: Handle to the BLOB that the caller configures.
hErrorBlob [out]: Handle to an error BLOB that contains additional error information. For information about the contents of an error BLOB, see the Remarks section in this topic.

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.
NMERR_NOT_ESP	The NPP is connected to the network but not with the IESP::Connect method.
NMERR_CAPTURING	The NPP reports that the capture session has started.
NMERR_ILLEGAL_TRIGGER	The trigger portion of the configuration BLOB is corrupt.
NMERR_BLOB_ENTRY_DOES_NOT_EXIST	The configuration BLOB specified by hConfigurationBlob is missing an entry needed to perform this operation. Look at the error BLOB returned by hErrorBlob to determine which entry was not found.
NMERR_BLOB_CONVERSION_ERROR	The BLOB is corrupt.
NMERR_BLOB_NOT_INITIALIZED	The CreateBlob method has not been called.
NMERR_INVALID_BLOB	The object that is pointed to is not a BLOB.
NMERR_BLOB_STRING_INVALID	The string is not null-terminated.
NMERR_UPLEVEL_BLOB	The BLOB version number is incorrect.
NMERR_OUT_OF_MEMORY	No memory was available. Shut down windows to free up resources.
NMERR_TIMEOUT	The request has timed out.

Remarks

You must apply this method to restart an NPP that has been started and stopped, but not disconnected.

The error BLOB returned by the hErrorBlob parameter contains entries that Network Monitor could not understand or find in the configuration BLOB specified in hConfigurationBlob. The returned error BLOB contains error information that the application can use for troubleshooting. For example, if NMERR_BLOB_ENTRY_DOES_NOT_EXIST is returned, the entry Network Monitor could not find is included in the returned error BLOB.

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

Share via