IStats::Configure method

Article
01/07/2021

The Configure method submits capture configuration information.

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.

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_BLOB_STRING_INVALID	The string is not null-terminated.
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_UPLEVEL_BLOB	The BLOB version number is incorrect.
NMERR_BLOB_ENTRY_ALREADY_EXISTS	A BLOB entry already exists.
NMERR_BLOB_ENTRY_DOES_NOT_EXIST	The configuration BLOB specified by the hConfigurationBlob parameter lacks an entry needed to perform this operation. Look at the error BLOB returned by the hErrorBlob parameter to determine which entry was not found.
NMERR_AMBIGUOUS_SPECIFIER	The BLOB lacks owner or category information.
NMERR_BLOB_OWNER_NOT_FOUND	The Owner section of the BLOB was not found.
NMERR_BLOB_CATEGORY_NOT_FOUND	The Category section of the BLOB was not found.
NMERR_UNKNOWN_CATEGORY	Category information was found but not understood.
NMERR_UNKNOWN_TAG	Tag information was found but not understood.
NMERR_BLOB_CONVERSION_ERROR	The BLOB is corrupt.
NMERR_ILLEGAL_TRIGGER	The trigger portion of the BLOB is corrupt.

Remarks

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

The error BLOB returned by hErrorBlob contains entries that Network Monitor could not understand or find in the configuration BLOB specified in the hConfigurationBlob parameter. 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