Remark

[The Remark property is no longer available for use as of Windows Server 2012.]

This property is not supported.

Windows Server 2003:  

Provides a description of the File Share resource. The following table summarizes the attributes of the Remark property.

AttributeValue
Data typeNull-terminated Unicode string
Access Read/write
StatusOptional
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 Remark can be set with the following example code.


WCHAR szRemarkData[] = L"File Share Description";
CLUSPROP_SZ_DECLARE( RemarkValue, 
                     sizeof(szRemarkData) / sizeof(WCHAR) );

RemarkValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
RemarkValue.cbLength  =  sizeof( szRemarkData );
StringCbCopy( RemarkValue.sz, RemarkValue.cbLength, szRemarkData );


Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2003 Enterprise, Windows Server 2003 Datacenter

End of server support

Windows Server 2003 Datacenter, Windows Server 2003 Enterprise

See also

File Share Private Properties
CLUSPROP_SZ
CLUSPROP_SZ_DECLARE

 

 

Show: