FormatProperties

The FormatProperties entry point is called to ask the parser to take all of the property instances and build the szPropertyText field in each PropertyInst structure.

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

Parameters

hFrame

Specifies the handle to the frame.

lpFrame

Specifies the pointer to the first byte for the frame.

lpProtocol

Specifies the pointer to the protocol start data.

nPropertyInsts

Specifies the number of properties attached on this frame by this parser.

lpPropInst

Specifies the pointer to the property instance or instances to be formatted. This is an array, and will be a pointer to one or more properties in an array.

Return Values

Should return TRUE if successful and FALSE if unsuccessful.

Remarks

FormatProperties is called to ask the parser to take all of the property instances and build the szPropertyText field in each PropertyInst structure. Each PropertyInst structure's szPropertyText field will point to a buffer of the maximum string size (as defined in AddProperty); the parser should fill the buffer pointed to in szPropertyText with the formatted string describing the property.

Note The string values returned in the property instance must be double-null-terminated. If a parser must describe a property with multiple lines, it can do so by returning multiple strings separated by \0, where the last string is terminated by a double \0.