PROPERTYINST structure

The PROPERTYINST structure defines an instance of a property in a piece of recognized data. Network Monitor allocates and fills in a PROPERTYINST structure when a property is attached to the capture.

Syntax

typedef struct _PROPERTYINST {
  LPPROPERTYINFO lpPropertyInfo;
  LPSTR          szPropertyText;
  union {
    LPVOID           lpData;
    ULPBYTE          lpByte;
    ULPWORD          lpWord;
    ULPDWORD         lpDword;
    ULPLARGEINT      lpLargeInt;
    ULPSYSTEMTIME    lpSysTime;
    LPPROPERTYINSTEX lpPropertyInstEx;
  };
  WORD           DataLength;
  WORD           Level  :4;
  WORD           HelpID  :12;
  DWORD          IFlags;
} PROPERTYINST, *LPPROPERTYINST;

Members

lpPropertyInfo

Pointer to the PROPERTYINFO structure that defines the property.

szPropertyText

Pointer to a string that is displayed in the details pane of the Network Monitor UI.

lpData

Pointer to the start of the data for the property. The parser determines where the property data starts.

lpByte

Pointer to the BYTE data.

lpWord

Pointer to the WORD data.

lpDword

Pointer to the DWORD data.

lpLargeInt

Pointer to the LARGEINT data.

lpSysTime

Pointer to the SYSTEMTIME data.

lpPropertyInstEx

Pointer to a PROPERTYINSTEX structure. The lpPropertyInstEx member is used only when you call AttachPropertyInstanceEx.

If lpPropertyInstEx is used, you must set the DataLength member to 0xFFFF.

DataLength

Data length for this instance of the property. If the lpPropertyInstEx member points to a PROPERTYINSTEX structure, you must set DataLength to 0xFFFF.

Level

Level information.

HelpID

Help file context identifier.

IFlags

Error condition flag.

Remarks

The PROPERTYINST structure defines an instance of an attached property. The parser accesses the PROPERTYINST structure through several helper functions. For example, when the FormatPropertyInstance function is called to format the data of a property, it modifies the szPropertyText member of the PROPERTYINST structure.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	Netmon.h

See also

AttachPropertyInstance

AttachPropertyInstanceEx