Share via


AddProperty

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

HPROPERTY WINAPIAddProperty(HPROTOCOLhProtocol,
LPPROPERTYINFOPropertyInfo);

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 Values

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

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.

Library

Link to Nmapi.lib.

DLL Requires Nmapi.dll.

See Also

CreatePropertyDatabase, PROPERTYINFO, Register