Description

Provides comments about the resource type. The following table summarizes the attributes of the Description property.

AttributeValue
Data typeNull-terminated Unicode string
Access Read/write
Structure CLUSPROP_SZ
MaximumNone (but see Maximum Property Size.)
DefaultNULL

 

Remarks

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 the following example code:


WCHAR szDescriptionData[] = L"Resource type 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

See also

CLUSPROP_SZ
CLUSPROP_SZ_DECLARE

 

 

Show: