IShareInfo.Description Property

  • Article

Gets the text description of the share.

Namespace: Microsoft.HomeServer.SDK.Interop.v1
Assembly: Microsoft.HomeServer.SDK.Interop.v1 (in microsoft.homeserver.sdk.interop.v1.dll)

Usage

Syntax

'Declaration
<DispIdAttribute(1610678273)> _
ReadOnly Property Description As String

[DispIdAttribute(1610678273)] 
string Description { get; }

[DispIdAttribute(1610678273)] 
property String^ Description {
    String^ get ();
}

/** @property */
String get_Description ()

function get Description () : String

Property Value

A string that contains the text description of the share.

Remarks

The Description is the same text that appears in the Comment section on the Sharing tab of the share properties dialog on the Windows Home Server computer.

Also, when end-users browse to the share using Windows Explorer, the description text appears under the Comments column in the details pane.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP

Target Platforms

Windows Home Server

See Also

Reference

IShareInfo Interface
IShareInfo Members
Microsoft.HomeServer.SDK.Interop.v1 Namespace