Partager via


Article.Description Property

Gets or sets a textual description of the article.

Espace de noms: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntaxe

'Déclaration
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)

Valeur de propriété

A String value that specifies the description of the article.

Exceptions

Type d'exception Condition
ArgumentException

When the value contains null characters or is longer than 128-Unicode characters.

Notes

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.

Sécurité des threads

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.

Plateformes

Plateformes de développement

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Plateformes cibles

Pour obtenir la liste des plateformes prises en charge, consultez Configuration matérielle et logicielle requise pour l'installation de SQL Server 2005.

Voir aussi

Référence

Article Class
Article Members
Microsoft.SqlServer.Replication Namespace

Autres ressources

How to: Define an Article (RMO Programming)
How to: View and Modify Article Properties (RMO Programming)