FilterAddObject function

The FilterAddObject function adds a single object to a display filter.

Syntax

DWORD WINAPI FilterAddObject(
  _In_  HFILTER        hFilter,
  _Out_ LPFILTEROBJECT lpFilterObject
);

Parameters

hFilter [in]

Handle to the display filter.

lpFilterObject [out]

Pointer to a FILTEROBJECT structure that defines the object to be added to the filter. Each object can be an operator, value, or property.

Return value

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

If the function is unsuccessful, the return value is an error code.

Return code	Description
NMERR_INVALID_PARAMETER	The hFilter parameter has an invalid value.
NMERR_OUT_OF_MEMORY	Network Monitor does not have enough memory to create the object.

Remarks

Experts and parsers can call the FilterAddObject function.

The FilterAddObject function is called each time a filter object is added to the display filter. The display filter is a postfix stack of objects that can be an operator, value, or property.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll

See also

FILTEROBJECT