• Article

MergeSubscription.Description Property

Gets or sets a textual description of the merge subscription.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Property Description As String
    Get
    Set
'Usage
Dim instance As MergeSubscription
Dim value As String

value = instance.Description

instance.Description = value

public string Description { get; set; }

public:
property String^ Description {
    String^ get ();
    void set (String^ value);
}

member Description : string with get, set

function get Description () : String
function set Description (value : String)

Property Value

Type: System.String
A String value that contains a textual description of the merge subscription.

Remarks

The Description property is used to specify a friendly name for the subscription.

The Description property can only be retrieved by members of the sysadmin fixed server role at the Publisher, members of the db_owner fixed database role on the publication database, or members of the publication access list for the publication to which the subscription belongs.

The Description property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.

Retrieving Description is equivalent to executing sp_helpmergesubscription.

Setting Description is equivalent to executing sp_addmergesubscription or sp_changemergesubscription.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.