MergeSubscription.Description Property

Article
12/03/2008

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

public string Description { get; set; }

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

/** @property */
public String get_Description ()

/** @property */
public void set_Description (String value)

public function get Description () : String

public function set Description (value : String)

Property Value

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.

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via