CLUSPROP_SYNTAX union (clusapi.h)

Article
2021-08-03

Describes the format and type of a data value. It is used as the Syntax member of the CLUSPROP_VALUE structure.

Syntax

typedef union CLUSPROP_SYNTAX {
  DWORD  dw;
  struct {
    WORD wFormat;
    WORD wType;
  } DUMMYSTRUCTNAME;
} CLUSPROP_SYNTAX, *PCLUSPROP_SYNTAX;

Members

dw

A DWORD that describes the format and type of the data value. The CLUSTER_PROPERTY_SYNTAX enumeration defines the possible values.

DUMMYSTRUCTNAME

DUMMYSTRUCTNAME.wFormat

Numeric value describing only the format of the data value. ClusAPI.h defines the following values, enumerated in the CLUSTER_PROPERTY_FORMAT enumeration.

wFormat.CLUSPROP_FORMAT_BINARY (1)

Data is a binary value.

wFormat.CLUSPROP_FORMAT_DWORD (2)

Data is a DWORD value.

wFormat.CLUSPROP_FORMAT_EXPAND_SZ (4)

Data is a null-terminated Unicode string with unexpanded references to environment variables.

wFormat.CLUSPROP_FORMAT_EXPANDED_SZ (8)

Data is a null-terminated Unicode string with expanded references to environment variables.

wFormat.CLUSPROP_FORMAT_FILETIME (12 (0xC))

Data is a FILETIME.

wFormat.CLUSPROP_FORMAT_LARGE_INTEGER (10 (0xA))

Data is a signed large integer.

wFormat.CLUSPROP_FORMAT_LONG (7)

Data is a signed LONG value.

wFormat.CLUSPROP_FORMAT_MULTI_SZ (5)

Data is an array of null-terminated Unicode strings.

wFormat.CLUSPROP_FORMAT_SECURITY_DESCRIPTOR (9)

Data is a SECURITY_DESCRIPTOR in self-relative format. For more information about self-relative security descriptors, see Absolute and Self-Relative Security Descriptors.

wFormat.CLUSPROP_FORMAT_SZ (3)

Data is a null-terminated Unicode string.

wFormat.CLUSPROP_FORMAT_ULARGE_INTEGER (6)

Data is an unsigned large integer.

wFormat.CLUSPROP_FORMAT_UNKNOWN (0)

Data is in an unknown format.

wFormat.CLUSPROP_FORMAT_USER (32768 (0x8000))

Data is in a user-defined format.

wFormat.CLUSPROP_FORMAT_WORD (11 (0xB))

Data is a WORD value.

DUMMYSTRUCTNAME.wType

Numeric value that describes only the type of the data value. The CLUSTER_PROPERTY_TYPE enumeration defines the possible values.

wType.CLUSPROP_TYPE_DISK_NUMBER (7)

Describes the number value of a disk resource. A disk number value is represented by a CLUSPROP_DISK_NUMBER structure.

wType.CLUSPROP_TYPE_DISK_SERIALNUMBER (10 (0xA))

Describes the serial number of a disk resource.

wType.CLUSPROP_TYPE_DISK_GUID (11 (0xB))

Describes the GUID of a disk resource.

wType.CLUSPROP_TYPE_DISK_SIZE (12 (0xC))

Describes the total size of the disk.

wType.CLUSPROP_TYPE_ENDMARK (0)

Designates the data value as the last entry in a property or value list.

wType.CLUSPROP_TYPE_LIST_VALUE (1)

Describes a data value in a property list. For example, in the property list passed to a control code function for a property validation operation, CLUSPROP_TYPE_LIST_VALUE is the required type to be included with each property value.

wType.CLUSPROP_TYPE_NAME (4)

Describes a data value used as a name, such as a property name. A name value is represented by a CLUSPROP_PROPERTY_NAME structure.

wType.CLUSPROP_TYPE_PARTITION_INFO (8)

Describes a collection of information about a disk resource, such as its device name and volume label. Partition data is represented by a CLUSPROP_PARTITION_INFO structure.

wType.CLUSPROP_TYPE_PARTITION_INFO_EX (13 (0xD))

Describes a collection of information about a disk resource, such as its device name and volume label. Partition data is represented by a CLUSPROP_PARTITION_INFO_EX structure.

wType.CLUSPROP_TYPE_RESCLASS (2)

Describes resource class information. A resource class value is described with a CLUSPROP_RESOURCE_CLASS structure. Resource classes are returned when an application calls ClusterResourceControl or ClusterResourceTypeControl with one of the following control codes.

CLUSCTL_RESOURCE_GET_CLASS_INFO

CLUSCTL_RESOURCE_TYPE_GET_CLASS_INFO

CLUSCTL_RESOURCE_TYPE_GET_REQUIRED_DEPENDENCIES

wType.CLUSPROP_TYPE_SCSI_ADDRESS (6)

Describes an Address property for an IP Address resource. A SCSI address value is represented by a CLUSPROP_SCSI_ADDRESS structure.

wType.CLUSPROP_TYPE_SIGNATURE (5)

Describes a Signature property for a disk resource. A signature value is represented by a CLUSPROP_DISK_SIGNATURE structure.

wType.CLUSPROP_TYPE_UNKNOWN (-1)

The type is unknown.

wType.CLUSPROP_TYPE_USER (32768 (0x8000))

Describes the beginning of the range for users to define their own types. Associate this type with user-defined private properties.

Remarks

To parse data that is returned from a control code function, use the wFormat member of this structure if the wType member defines a type that the application cannot understand.

Examples

See Creating Physical Disk Resources and Building with CLUSPROP_BUFFER_HELPER.

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	clusapi.h

Share via