AddProperty Function

Article
11/09/2009

The AddProperty function adds one property to the parser property database.

Syntax

HPROPERTY WINAPI AddProperty(
  __in  HPROTOCOL hProtocol,
  __in  LPPROPERTYINFO PropertyInfo
);

Parameters

hProtocol [in]
Handle of the protocol that is associated with the database. When Network Monitor calls the Register function, Network Monitor passes the protocol handle to the parser DLL.
PropertyInfo [in]
Pointer to a PROPERTYINFO structure that defines the property.

Return Value

If the function is successful, the return value is a pointer to the property that is added.

If the function is unsuccessful, the return value is NULL.

Remarks

The AddProperty function should be called only when implementing the Register function. The parser uses AddProperty to add a property to the property database of the protocol. Properties are added to the database one property at a time.

AddProperty must be called after calling CreatePropertyDatabase. If AddProperty is called before the property database is created, Network Monitor returns the NMERR_NO_PROPERTY_DATABASE error.

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Header	Netmon.h
Library	Nmapi.lib
DLL	Nmapi.dll