PullSubscription.Description Property
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
Get
Set
'Usage
Dim instance As PullSubscription
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 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).