Remark Property for File Shares

The Remark property provides a description of the File Share resource.

Quick Info

Type: Null-terminated Unicode string
Access: Read/write
Status: Required
Function: ClusterResourceControl
Structure: CLUSPROP_SZ
Control Code: CLUSCTL_RESOURCE_GET_PRIVATE_PROPERTIES

Remarks

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

CLUSPROP_SZ RemarkValue;
LPCWSTR RemarkData = L "File Share Description";
RemarkValue.Syntax = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
RemarkValue.cbLength = sizeof(RemarkData);
lstrcpyW(RemarkValue.sz, RemarkData);

QuickInfo

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