PullSubscription.Description Property

Article
12/03/2008

Gets or sets a textual description of the pull 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.

Remarks

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

Once the subscription exists on the server, the Description property cannot be changed.

The Description property can only be retrieved by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.

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

Retrieving the Description property is equivalent to executing sp_helppullsubscription (Transact-SQL) or sp_helpmergepullsubscription (Transact-SQL).

Setting the Description property is equivalent to executing sp_addpullsubscription (Transact-SQL), sp_addmergepullsubscription (Transact-SQL), sp_changesubscription (Transact-SQL), or sp_changemergesubscription (Transact-SQL).

The Description property is available with SQL Server 7.0, SQL Server 2000, and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .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