Description Property for Resource Types

The Description property provides remarks or comments about the resource type.

Quick Info

Type: Null-terminated Unicode string
Access: Read/write
Function: ClusterResourceTypeControl
Structures: CLUSPROP_SZ
Control Codes: CLUSCTL_RESOURCE_TYPE_GET_COMMON_PROPERTIES

Remarks

When ClusterResourceTypeControl processes the CLUSCTL_RESOURCE_TYPE_GET_COMMON_PROPERTIES control code, it returns a property list that includes the Description property as one of the entries. The property value portion of the entry contains a CLUSPROP_SZ structure that is set as follows:

LPCWSTR DescriptionData = L "Description of resource type";
CLUSPROP_SZ DescriptionValue;
DescriptionValue.Syntax = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
DescriptionValue.cbLength = sizeof(DescriptionData);
lstrcpyW(DescriptionValue.sz, DescriptionData);

QuickInfo

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