CLUSPROP_SYNTAX

The CLUSPROP_SYNTAX union describes the format and type of a data value. The CLUSPROP_SYNTAX structure is defined in CLUSAPI.H.

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

Members

dw
Numeric value describing the combined format and type of the data value. The following values are valid:
CLUSPROP_SYNTAX_LIST_VALUE_BINARY
Describes a binary value to be included in a property list.
CLUSPROP_SYNTAX_LIST_VALUE_DWORD
Describes a DWORD value to be included in a property list.
CLUSPROP_SYNTAX_LIST_VALUE_EXPAND_SZ
Describes a string value with unexpanded references to environment variables to be included in a property list.
CLUSPROP_SYNTAX_LIST_VALUE_MULTI_SZ
Describes an array of string values to be included in a property list.
CLUSPROP_SYNTAX_LIST_VALUE_SZ
Describes a string value to be included in a property list.
CLUSPROP_SYNTAX_DISK_NUMBER
Describes the number value of a Physical Disk resource. This value is represented by a CLUSPROP_DISK_NUMBER structure.
CLUSPROP_SYNTAX_DISK_SIGNATURE
Describes a Signature property value for a Physical Disk resource. A signature value is represented by a CLUSPROP_DISK_SIGNATURE structure.
CLUSPROP_SYNTAX_ENDMARK
Designates the data value as the last entry in a property or value list.
CLUSPROP_SYNTAX_NAME
Describes a property name, such as the Name property for resources and the NodeName property for nodes. A property name is represented by a CLUSPROP_PROPERTY_NAME structure.
CLUSPROP_SYNTAX_PARTITION_INFO
Describes a collection of information about a Physical Disk resource such as its device name and volume label. Partition information is represented by a CLUSPROP_PARTITION_INFO structure.
CLUSPROP_SYNTAX_RESCLASS
Describes a resource class value. A resource class value is represented by a CLUSPROP_RESOURCE_CLASS structure.
CLUSPROP_SYNTAX_SCSI_ADDRESS
Describes the address for an IP Address resource. IP Address resources store this address in their Address private property. A SCSI address value is represented by a CLUSPROP_SCSI_ADDRESS structure.
wFormat
Numeric value describing only the format of the data value. The following values are valid:
Format value Description
CLUSPROP_FORMAT_UNKNOWN Data is in an unknown format.
CLUSPROP_FORMAT_BINARY Data is a binary value.
CLUSPROP_FORMAT_DWORD Data is a DWORD value.
CLUSPROP_FORMAT_EXPAND_SZ Data is a character string with unexpanded references to environment variables.
CLUSPROP_FORMAT_MULTI_SZ Data is an array of character strings.
CLUSPROP_FORMAT_SZ Data is a character string.
CLUSPROP_FORMAT_ULARGE_
INTEGER		 Data is an unsigned large integer.
CLUSPROP_FORMAT_USER Data is in a user-defined format.
wType
Numeric value that describes only the type of the data value. The following types are valid:
CLUSPROP_TYPE_DISK_NUMBER
Describes the number value of a disk resource. A disk number value is represented by a CLUSPROP_DISK_NUMBER structure.
CLUSPROP_TYPE_ENDMARK
Designates the data value as the last entry in a property or value list.
CLUSPROP_TYPE_LIST_VALUE
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.
CLUSPROP_TYPE_NAME
Describes a data value used as a name, such as a property name. A name value is represented by a CLUSPROP_PROPERTY_NAME structure.
CLUSPROP_TYPE_PARTITION_INFO
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.
CLUSPROP_TYPE_RESCLASS
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

CLUSPROP_TYPE_SCSI_ADDRESS
Describes an Address property for an IP address resource. A SCSI address value is represented by a CLUSPROP_SCSI_ADDRESS structure.
CLUSPROP_TYPE_SIGNATURE
Describes a Signature property for a disk resource. A signature value is represented by a CLUSPROP_DISK_SIGNATURE structure.
CLUSPROP_TYPE_USER
Describes the beginning of the range for users to define their own types. Associate this type with user-defined private properties.

Remarks

The wType member of the CLUSPROP_SYNTAX structure is set to one of the following values when ClusterResourceControl is handling the CLUSCTL_RESOURCE_STORAGE_GET_DISK_INFO control code and when ClusterResourceTypeControl is handling the CLUSCTL_RESOURCE_TYPE_STORAGE_GET_AVAILABLE_DISKS control code:

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

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.