CreatePropertyDatabase Function

Article
11/09/2009

The CreatePropertyDatabase function creates a property database that stores the properties of a protocol.

Syntax

DWORD WINAPI CreatePropertyDatabase(
  __in  HPROTOCOL hProtocol,
  __in  DWORD nProperties
);

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.
nProperties [in]
Number of properties stored in the database. Set this parameter to the number of properties that the protocol supports.

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_INTERNAL_ERROR	An internal error has occurred.
NMERR_INVALID_HPOTOCOL	The handle to the protocol specified in hProtocol is invalid.
NMERR_OUT_OF_MEMORY	Network Monitor does not have enough memory to create the database.

Remarks

The CreatePropertyDatabase function should be called only when implementing the Register function. The parser uses CreatePropertyDatabase to create a property database that describes the properties of a protocol. Network Monitor uses the database to interpret the information within the protocol.

The CreatePropertyDatabase function allocates the structures that Network Monitor needs to maintain a property database.

Requirements

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