RESUTIL_PROPERTY_ITEM structure

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;
  };
  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.

( unnamed union )

The default value of the property in one of the following forms.

DefaultPtr

Pointer to a DWORD default value.

Default

A DWORD default value.

lpDefault

Void pointer to a buffer containing the default value.

LargeIntData

Pointer to a RESUTIL_LARGEINT_DATA structure describing the maximum, minimum, and default values for a signed large integer.

ULargeIntData

Pointer to a RESUTIL_ULARGEINT_DATA structure describing the maximum, minimum, and default values for an unsigned large integer. The default value must be consistent with the format specified by the Format member.

FileTimeData

Pointer to a RESUTIL_FILETIME_DATA structure describing the file data and time data.

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.

FlagMeaning
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

Minimum supported client

None supported

Minimum supported server

Windows Server 2003 Enterprise, Windows Server 2003 Datacenter

Header

ResApi.h

See also

CLUSPROP_SYNTAX

 

 

Show:
© 2014 Microsoft