RESUTIL_PROPERTY_ITEM structure (resapi.h)

Contains information about a cluster object property. An array of RESUTIL_PROPERTY_ITEM structures forms a property table which can be used in property operations.

Syntax

typedef struct RESUTIL_PROPERTY_ITEM {
  LPWSTR Name;
  LPWSTR KeyName;
  DWORD  Format;
  union {
    DWORD_PTR               DefaultPtr;
    DWORD                   Default;
    LPVOID                  lpDefault;
    PRESUTIL_LARGEINT_DATA  LargeIntData;
    PRESUTIL_ULARGEINT_DATA ULargeIntData;
    PRESUTIL_FILETIME_DATA  FileTimeData;
  } DUMMYUNIONNAME;
  DWORD  Minimum;
  DWORD  Maximum;
  DWORD  Flags;
  DWORD  Offset;
} RESUTIL_PROPERTY_ITEM, *PRESUTIL_PROPERTY_ITEM;

Members

Name

The name of the property.

KeyName

Optional name of the cluster database subkey for the property. This parameter can be NULL.

Format

Describes the format of the property such as CLUSPROP_FORMAT_BINARY or CLUSPROP_FORMAT_DWORD. For a list of valid format values, see the wFormat member of CLUSPROP_SYNTAX.

DUMMYUNIONNAME

DUMMYUNIONNAME.DefaultPtr

DUMMYUNIONNAME.Default

DUMMYUNIONNAME.lpDefault

DUMMYUNIONNAME.LargeIntData

DUMMYUNIONNAME.ULargeIntData

DUMMYUNIONNAME.FileTimeData

Minimum

Minimum data value for the property. For data values with the CLUSPROP_FORMAT_BINARY and CLUSPROP_FORMAT_MULTI_SZ formats, the Minimum member contains the byte size of the default data value specified by Default.

Maximum

Maximum data value for the property.

Flags

Bitmask that describes the property.

RESUTIL_PROPITEM_READ_ONLY (0x00000001)

The property is read-only.

RESUTIL_PROPITEM_REQUIRED (0x00000002)

The property is required.

RESUTIL_PROPITEM_SIGNED (0x00000004)

Flags a numeric property as a signed value.

Offset

Byte offset to the actual property data. The data is stored in a buffer known as a parameter block.

Remarks

For more information about building parameter blocks and property tables, see Using Lists and Tables.

Examples

See Using Lists and Tables and Building with CLUSPROP_BUFFER_HELPER, and Defining Structures and Constants in Implementing Resource DLLs.

Requirements

See also

CLUSPROP_SYNTAX