FormatProperties Callback Function

Article
11/09/2009

The FormatProperties export function formats the data that is displayed in the details pane of the Network Monitor UI. If you want to display data in the details pane, you must implement the FormatProperties export function in all parser DLLs.

Syntax

DWORD FormatProperties(
  __in  HFRAME hFrame,
  __in  LPBYTE lpFrame,
  __in  LPBYTE lpProtocol,
  __in  DWORD nPropertyInsts,
  __in  LPPROPERTYINST lpPropInst
);

Parameters

hFrame [in]
Handle to the frame that is being parsed.
lpFrame [in]
Pointer to the first byte of a frame.
lpProtocol [in]
Pointer to the beginning of the protocol data in a frame.
nPropertyInsts [in]
Number of PROPERTYINST structures provided by lpPropInst.
lpPropInst [in]
Pointer to an array of PROPERTYINST structures.

Return Value

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

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

Remarks

Network Monitor calls the FormatProperties function to display data in the details pane of the Network Monitor UI. Typically, FormatProperties is called to format the summary line for a protocol, and then to format all the property instances of the protocol within a frame. However, Network Monitor does not guarantee the number of times it calls FormatProperties for a specific parser.

During the implementation of the FormatProperties function, the parser indirectly calls the FormatPropertyInstance function to use the generic formatter that Network Monitor provides, or it can call a custom formatter procedure that is defined by the parser. One of the formatters must be called for each PROPERTYINST structure passed to the parser DLL in the lpPropInst parameter.

For Information on	See
What parsers are, and how they work with Network Monitor.	Parsers
Which entry points are included in the parser DLL.	Parser DLL Architecture
How to implement FormatProperties— includes an example.	Implementing FormatProperties
How the generic formatter formats different types of data.	Generic Formatter Output

Requirements

Minimum supported client	Windows 2000 Professional
Minimum supported server	Windows 2000 Server
Header	Netmon.h

Share via