Share via

PROPERTYINFO

  • Article

The PROPERTYINFO data structure defines one property of the protocol.

typedef struct _PROPERTYINFO {
  HPROPERTY hProperty;
  DWORD Version;
  LPSTR Label;
  LPSTR Comment;
  BYTE DataType;
  BYTE DataQualifier;
  union {
    LPVOID lpExtendedInfo;
    LPRANGE lpRange;
    LPSET lpSet;
    DWORD Bitmask;
    DWORD Value;
  };
  WORD FormatStringSize;
  LPVOID InstanceData;
} PROPERTYINFO, 
 *LPPROPERTYINFO;

Members

  • hProperty
    Set this field to zero. On output, Network Monitor returns a handle to the property after the property is added to the property database.

  • Version
    Reserved. Must be set to zero.

  • Label
    Name of the property.

  • Comment
    Description of the property. The description appears on the Network Monitor status bar.

  • DataType
    Data type of the property. This member can have one of the following values.

    Value Meaning
    PROP_TYPE_VOID Property type is unknown. There is no implied length or format.
    PROP_TYPE_SUMMARY Summarizing property type. Indicates the first property instance that the parser attaches to a frame. PROP_TYPE_SUMMARY can serve as a placeholder for groups of properties. This value indicates that the property is not defined in the protocol RFC.
    PROP_TYPE_BYTE Numeric data with a size of one byte (8-bit entity).
    PROP_TYPE_WORD Numeric data with a size of two bytes (16-bit entity).
    PROP_TYPE_DWORD Numeric data with a size of four bytes (32-bit entity).
    PROP_TYPE_LARGEINT Numeric data with a size of eight bytes (64-bit entity).
    PROP_TYPE_ADDR MAC address (6-byte entity).
    PROP_TYPE_TIME SYSTEMTIME structure.
    PROP_TYPE_STRING ASCII text data. This data type is not NULL-terminated.

    For Unicode data, when ASCII text data is specified, the IFLAG_UNICODE flag must also be set when the attach property instance function is called.
    PROP_TYPE_IP_ADDRESS IP Address. (4-byte entity).
    PROP_TYPE_IPX_ADDRESS IPX Address. (10-byte entity).
    PROP_TYPE_BYTESWAPPED_WORD Obsolete. For byte-swapped WORD data, set DataType to PROP_TYPE_WORD and set the IFLAG_SWAPPED flag when calling an Attach property instance function.
    PROP_TYPE_BYTESWAPPED_DWORD Obsolete. For byte-swapped DWORD data, set DataType to PROP_TYPE_DWORD and set the IFLAG_SWAPPED flag when calling an Attach property instance function.
    PROP_TYPE_TYPED_STRING Obsolete. For variable-type string data, set DataType to PROP_TYPE_STRING and set the IFLAG_UNICODE flag when calling an Attach property instance function.
    PROP_TYPE_RAW_DATA Raw data of unknown length and format.
    PROP_TYPE_COMMENT Same as PROP_TYPE_VOID.
    PROP_TYPE_SRCFRIENDLYNAME Address of source-friendly name. Network Monitor does not provide built-in formatting support for this data type.
    PROP_TYPE_DSTFRIENDLYNAME Address of destination friendly name. Network Monitor does not provide built-in formatting support for this data type.
    PROP_TYPE_TOKENRING_ADDRESS Token-ring address. Network Monitor does not provide built-in formatting support for this data type.
    PROP_TYPE_FDDI_ADDRESS FDDI address. Network Monitor does not provide built-in formatting support for this data type.
    PROP_TYPE_ETHERNET_ADDRESS Ethernet address. Network Monitor does not provide built-in formatting support for this data type.
    PROP_TYPE_OBJECT_IDENTIFIER BER-encoded SNMP object identifier.
    PROP_TYPE_VINES_IP_ADDRESS Vines IP address (6-byte entity).
    PROP_TYPE_VAR_LEN_SMALL_INT Numeric value without a pre-determined length, but no more than 8 bytes long. The length of the attached data determines the length of the value.

  • DataQualifier
    The data qualifier of a property. This member provides precise information about the data type.

    DataQualifier can have one of the following values.

    Value Meaning
    PROP_QUAL_NONE The property data type is the only specification of the property.

    When this value is set, the union member of the structure is set to NULL, and then ignored.
    PROP_QUAL_RANGE The numeric value is expected to be within a given range. Define the range in the lpRange member.
    PROP_QUAL_SET The value of a property is compared to a set of values that are specified in the lpSet member of the structure's union. The value of a property can be a BYTE, WORD, DWORD, LARGEINT or TIME.
    PROP_QUAL_BITFIELD Obsolete.
    PROP_QUAL_LABELED_SET The value of a property is compared to a value in a set of value label pairs. The value label pairs are specified in the lpSet member of the structure's union.

    At display time, if the value of the property matches a value in the set, then both a value, and the associated label are displayed.
    PROP_QUAL_LABELED_BITFIELD Obsolete. Use PROP_QUAL_FLAGS instead.
    PROP_QUAL_CONST The value of a property is compared to a constant that is specified in the Value member of the union.

    At display time, if the property values and constant do not match, a formatted error message appears with the value set as Normal.
    PROP_QUAL_FLAGS The value of the property is compared to specific BITs identified in the lpSet member of the union.
    PROP_QUAL_ARRAY The value of a property specifies an array of values. The length of attached data determines the length of an array.

    When the PROP_QUAL_ARRAY value is set, the union member of the PROPERTYINFO data structure is set to NULL and ignored.

  • lpExtendedInfo
    Reserved (member of union).

  • lpRange
    Pointer to a RANGE structure that defines a range of values. This member must be set if the DataQualifier member of this structure is set to PROP_QUAL_RANGE (member of union).

  • lpSet
    Pointer to a SET structure that specifies a set of values or labels. This member must be set if the DataQualifier member of the structure is set to PROP_QUAL_SET, PROP_QUAL_LABELED_SET, or PROP_QUAL_FLAGS (member of union).

  • Bitmask
    Obsolete (member of union).

  • Value
    Constant value used when the DataQualifier is set to PROP_QUAL_CONST (member of union).

  • FormatStringSize
    Maximum size used only for the property description.

  • InstanceData
    Specify the format function that is called to format the displayed data for the property. To use the generic formatter, specify the FormatPropertyInstance function.

Remarks

The PROPERTYINFO structure is used in calls to the AddProperty function. The AddProperty function adds a single property definition to the parser property database.

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.

See Also

AddProperty, RANGE, SET