2.2.2.2 CLUSTER_PROPERTY_FORMAT

  • Article

The CLUSTER_PROPERTY_FORMAT enumeration is used to specify the data type of a property value in a PROPERTY_LIST (section 2.2.3.10) structure.

CLUSTER_PROPERTY_FORMAT values are 16-bit unsigned integers. CLUSTER_PROPERTY_FORMAT values provide the lower 2 bytes for the CLUSTER_PROPERTY_SYNTAX (section 2.2.2.3) enumeration values.

CLUSTER_PROPERTY_FORMAT values identify the type of representation of a data value that is stored in a PROPERTY_LIST. Using the CLUSTER_PROPERTY_FORMAT value, a client that is parsing a PROPERTY_LIST can correctly interpret a buffer of bytes in a PROPERTY_LIST value as the correct, specific data type.

These values MUST be used when specifying the representation of a value that is stored in a PROPERTY_LIST. Any other value, when received in a form that specifies the representation of a value that is stored in a PROPERTY_LIST, MUST be treated as an error.

 typedef  enum 
 {
   CLUSPROP_FORMAT_UNKNOWN = 0x0000,
   CLUSPROP_FORMAT_BINARY = 0x0001,
   CLUSPROP_FORMAT_DWORD = 0x0002,
   CLUSPROP_FORMAT_SZ = 0x0003,
   CLUSPROP_FORMAT_EXPAND_SZ = 0x0004,
   CLUSPROP_FORMAT_MULTI_SZ = 0x0005,
   CLUSPROP_FORMAT_ULARGE_INTEGER = 0x0006,
   CLUSPROP_FORMAT_LONG = 0x0007,
   CLUSPROP_FORMAT_EXPANDED_SZ = 0x0008,
   CLUSPROP_FORMAT_SECURITY_DESCRIPTOR = 0x0009,
   CLUSPROP_FORMAT_LARGE_INTEGER = 0x000a,
   CLUSPROP_FORMAT_WORD = 0x000b,
   CLUSPROP_FORMAT_FILETIME = 0x000c
 } CLUSTER_PROPERTY_FORMAT;

CLUSPROP_FORMAT_UNKNOWN: The property format is unknown, or this property value represents an end mark for a value list.

CLUSPROP_FORMAT_BINARY: The property value contains data, but the data MUST NOT be interpreted or assigned a more granular structure.

CLUSPROP_FORMAT_DWORD: The property value is an unsigned long integer.

CLUSPROP_FORMAT_SZ: The property value is a null-terminated Unicode string.

CLUSPROP_FORMAT_EXPAND_SZ: The property value is a null-terminated Unicode string that contains embedded environment variables.

CLUSPROP_FORMAT_MULTI_SZ: The property value in the format string, as specified for REG_MULTI_SZ in [MS-RRP] (section 2.2.5).

CLUSPROP_FORMAT_ULARGE_INTEGER: The property value is a ULARGE_INTEGER structure, as specified in [MS-DTYP] section 2.3.15.

CLUSPROP_FORMAT_LONG: The property value is a 32-bit signed integer.

CLUSPROP_FORMAT_EXPANDED_SZ: The property value is a null-terminated Unicode string where embedded environment variables have been substituted with their corresponding values as stored on the server. See section 2.2.2.3 for more information.

CLUSPROP_FORMAT_SECURITY_DESCRIPTOR: The property value is a SECURITY_DESCRIPTOR structure, as specified in [MS-DTYP] section 2.4.6.

CLUSPROP_FORMAT_LARGE_INTEGER: The property value is a LARGE_INTEGER structure, as specified in [MS-DTYP] section 2.3.5.

CLUSPROP_FORMAT_WORD: The property value is a 16-bit unsigned integer.

CLUSPROP_FORMAT_FILETIME: The property value is a FILETIME structure, as specified in [MS-DTYP] section 2.3.3.