Article.Description Property
Gets or sets a textual description of the article.
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 Article
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 specifies the description of the article.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | When the value contains nulla null reference (Nothing in Visual Basic) characters or is longer than 128-Unicode characters. |
Remarks
The Description property is a read/write property.
The Description property can be retrieved by members of the sysadmin fixed server role at the Publisher and at the Subscriber (for republishing Subscribers). It can also be retrieved by members of the db_owner fixed database role on the publication database and by users who are members of the PAL. For a MergeArticle object, this property can also be retrieved by members of the replmonitor fixed database role on the Distributor.
The Description property can be set by members of the sysadmin fixed server role at the Publisher. It can also be set by members of the db_owner fixed database role on the publication database.
Retrieving Description is equivalent to executing sp_helparticle (Transact-SQL) for transactional or snapshot replication or executing sp_helpmergearticle (Transact-SQL) for merge replication.
Setting Description is equivalent to executing sp_addarticle (Transact-SQL) or sp_changearticle (Transact-SQL) for transactional or snapshot replication, or executing sp_addmergearticle (Transact-SQL) or sp_changemergearticle (Transact-SQL) for merge replication.
The Description property is available with SQL Server 2005, SQL Server 2000, and SQL Server 7.0.
This namespace, class, or member is supported only in the .NET Framework 2.0.