Article.Description Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a textual description of the article.
public:
property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };public string Description { get; set; }member this.Description : string with get, setPublic Property Description As StringProperty Value
The description of the article.
Exceptions
When the value contains null 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.