Description
Stores administrative comments about the cluster. The following table summarizes the attributes of the Description property.
| Attribute | Value |
|---|---|
| Data type | NULL-terminated Unicode string |
| Access | Read/write |
| Structure | CLUSPROP_SZ |
| Maximum | None (but see Maximum Property Size.) |
| Default | NULL |
Remarks
The constant for this property is CLUSREG_NAME_CLUS_DESC.
The CLUSPROP_SZ_DECLARE macro creates a CLUSPROP_SZ structure with an array of the correct size.
Examples
The property value portion of a property list entry for Description can be set with with the following example code:
WCHAR szDescriptionData[] = L"Cluster description";
CLUSPROP_SZ_DECLARE( DescriptionValue, sizeof( szDescriptionData ) / sizeof( WCHAR ) );
DescriptionValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
DescriptionValue.cbLength = sizeof( szDescriptionData );
StringCbCopy( DescriptionValue.sz, DescriptionValue.cbLength, szDescriptionData );
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter |