CLUSTER_PROPERTY_SYNTAX enumeration (clusapi.h)

2022-08-03

Provides the possible values for the syntax structures in a property list.

Syntax

typedef enum CLUSTER_PROPERTY_SYNTAX {
  CLUSPROP_SYNTAX_ENDMARK,
  CLUSPROP_SYNTAX_NAME,
  CLUSPROP_SYNTAX_RESCLASS,
  CLUSPROP_SYNTAX_LIST_VALUE_SZ,
  CLUSPROP_SYNTAX_LIST_VALUE_EXPAND_SZ,
  CLUSPROP_SYNTAX_LIST_VALUE_DWORD,
  CLUSPROP_SYNTAX_LIST_VALUE_BINARY,
  CLUSPROP_SYNTAX_LIST_VALUE_MULTI_SZ,
  CLUSPROP_SYNTAX_LIST_VALUE_LONG,
  CLUSPROP_SYNTAX_LIST_VALUE_EXPANDED_SZ,
  CLUSPROP_SYNTAX_LIST_VALUE_SECURITY_DESCRIPTOR,
  CLUSPROP_SYNTAX_LIST_VALUE_LARGE_INTEGER,
  CLUSPROP_SYNTAX_LIST_VALUE_ULARGE_INTEGER,
  CLUSPROP_SYNTAX_LIST_VALUE_WORD,
  CLUSPROP_SYNTAX_LIST_VALUE_PROPERTY_LIST,
  CLUSPROP_SYNTAX_LIST_VALUE_FILETIME,
  CLUSPROP_SYNTAX_DISK_SIGNATURE,
  CLUSPROP_SYNTAX_SCSI_ADDRESS,
  CLUSPROP_SYNTAX_DISK_NUMBER,
  CLUSPROP_SYNTAX_PARTITION_INFO,
  CLUSPROP_SYNTAX_FTSET_INFO,
  CLUSPROP_SYNTAX_DISK_SERIALNUMBER,
  CLUSPROP_SYNTAX_DISK_GUID,
  CLUSPROP_SYNTAX_DISK_SIZE,
  CLUSPROP_SYNTAX_PARTITION_INFO_EX,
  CLUSPROP_SYNTAX_PARTITION_INFO_EX2,
  CLUSPROP_SYNTAX_STORAGE_DEVICE_ID_DESCRIPTOR
} ;

Constants


`CLUSPROP_SYNTAX_ENDMARK` Marks the end of a 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_RESCLASS` Describes a resource class value. A resource class value is represented by a CLUSPROP_RESOURCE_CLASS structure.
`CLUSPROP_SYNTAX_LIST_VALUE_SZ` Describes a null-terminated Unicode string value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_EXPAND_SZ` Describes a null-terminated Unicode string value with unexpanded references to environment variables in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_DWORD` Describes a DWORD value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_BINARY` Describes a binary value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_MULTI_SZ` Describes an array of null-terminated Unicode string values in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_LONG` Describes a signed long value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_EXPANDED_SZ` Describes a null-terminated Unicode string value with expanded references to environment variables in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_SECURITY_DESCRIPTOR` Describes a SECURITY_DESCRIPTOR in self-relative format in a property list. For more information about self-relative security descriptors, see Absolute and Self-Relative Security Descriptors.
`CLUSPROP_SYNTAX_LIST_VALUE_LARGE_INTEGER` Describes a signed large integer value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_ULARGE_INTEGER` Describes an unsigned large integer value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_WORD` Describes a WORD value in a property list.
`CLUSPROP_SYNTAX_LIST_VALUE_PROPERTY_LIST` Describes a property list. Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: This enumeration value is not supported until Windows Server 2016.
`CLUSPROP_SYNTAX_LIST_VALUE_FILETIME` Describes a FILETIME value in a property list. Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: This enumeration value is not supported until Windows Server 2016.
`CLUSPROP_SYNTAX_DISK_SIGNATURE` Describes a master boot record (MBR) disk signature value represented by a CLUSPROP_DISK_SIGNATURE 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.
`CLUSPROP_SYNTAX_DISK_NUMBER` Describes a disk number value represented by a CLUSPROP_DISK_NUMBER 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_FTSET_INFO` Describes FILETIME set information.
`CLUSPROP_SYNTAX_DISK_SERIALNUMBER` Describes a null-terminated Unicode string value containing a serial number of a disk resource.
`CLUSPROP_SYNTAX_DISK_GUID` Describes a null-terminated Unicode string value containing the GUID of a GUID partitioning table (GPT) disk resource.
`CLUSPROP_SYNTAX_DISK_SIZE` Describes a unsigned large integer value containing the total size of a disk in bytes.
`CLUSPROP_SYNTAX_PARTITION_INFO_EX` 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_EX structure.
`CLUSPROP_SYNTAX_PARTITION_INFO_EX2` Describes a collection of information about a Physical Disk resource, such as its device name and volume label. The partition information is represented by a CLUSPROP_PARTITION_INFO_EX2 structure. Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: This value is not available until Windows Server 2016 .
`CLUSPROP_SYNTAX_STORAGE_DEVICE_ID_DESCRIPTOR` Describes descriptor data for a storage class resource. Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: This value is not available until Windows Server 2016 .

Remarks

The upper 2 bytes of a CLUSTER_PROPERTY_SYNTAX must be a valid CLUSTER_PROPERTY_TYPE. The lower 2 bytes of a CLUSTER_PROPERTY_SYNTAX must be a valid CLUSTER_PROPERTY_FORMAT.

The client must not specify a syntax value of CLUSPROP_SYNTAX_LIST_VALUE_EXPANDED_SZ when adding a property value to a property list structure. When constructing a property list structure to return to the client, the server must return two values for a property's value that is of syntax CLUSPROP_SYNTAX_LIST_VALUE_EXPAND_SZ: the first value is of syntax CLUSPROP_SYNTAX_LIST_VALUE_EXPAND_SZ, containing the property value, as it is stored on the server, and the second is of syntax CLUSPROP_SYNTAX_LIST_VALUE_EXPANDED_SZ which is the same property value where each embedded environment variable has been replaced by its value, as stored on the server.

Requirements

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

Feedback

Was this page helpful?