PullSubscription.Description Property

Definition

Gets or sets a textual description of the pull subscription.

public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };
public string Description { get; set; }
member this.Description : string with get, set
Public Property Description As String

Property Value

A textual description of the pull subscription.

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).

Applies to