CLUSPROP_VALUE

The CLUSPROP_VALUE structure describes the syntax and length of a data value used in a value list. The CLUSPROP_VALUE structure is used as a generic header in all of the structures that describe data of a particular type, such as CLUSPROP_BINARY and CLUSPROP_SZ. The CLUSPROP_VALUE structure is defined in CLUSAPI.H.

typedef struct _CLUSPROP_VALUE {
    CLUSPROP_SYNTAX           Syntax;
    DWORD                     cbLength;
} CLUSPROP_VALUE, *PCLUSPROP_VALUE;
 

Members

Syntax

CLUSPROP_SYNTAX union that describes a value.

cbLength

Count of bytes in the data that follows this CLUSPROP_VALUE structure. The count does not include the value header. It is an actual byte count, meaning that if there is padding to fulfill the DWORD boundary requirement, the padding characters are not included in cbLength. To move past the data in a single entry in the property list, use the ALIGN_CLUSPROP macro. ALIGN_CLUSPROP rounds up to the next DWORD value in the list.

Remarks

The CLUSPROP_VALUE structure is used to describe the format, type, and length of a data value in the following structures:

CLUSPROP_BINARY

CLUSPROP_DISK_NUMBER

CLUSPROP_DISK_SIGNATURE

CLUSPROP_DWORD

CLUSPROP_MULTI_SZ

CLUSPROP_PARTITION_INFO

CLUSPROP_PROPERTY_NAME

CLUSPROP_REQUIRED_DEPENDENCY

CLUSPROP_RESOURCE_CLASS

CLUSPROP_RESOURCE_CLASS_INFO

CLUSPROP_SCSI_ADDRESS

CLUSPROP_SZ

CLUSPROP_ULARGE_INTEGER

To ensure that entries in a property list are properly aligned, do not use the malloc function to allocate the memory for these entries. Instead, use the Win32® function LocalAlloc.

The following code sample illustrates how to access an entry in a property list:

CLUSPROP_BUFFER_HELPER buf;
buf.pb += sizeof(*(buf.pValue)) + ALIGN_CLUSPROP
(buf.pValue->cbLength);
 

QuickInfo

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