• Article

Publication.Description Property

Gets or sets a textual description of the publication.

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 Publication
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 contains a textual description of the publication.

Remarks

The Description property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by users in the publication access list (PAL).

The Description property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database. Users in the PAL can set the Description property of an existing publication.

Retrieving the Description property is equivalent to executing sp_helppublicationsp_helppublication (Transact-SQL) or sp_helpmergepublicationsp_helpmergepublication (Transact-SQL).

Setting the Description property is equivalent to executing sp_addpublication (Transact-SQL) and sp_changepublication (Transact-SQL) or sp_addmergepublication (Transact-SQL) and sp_changemergepublication (Transact-SQL).

The Description property is available with SQL Server 7.0, SQL Server 2000, and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.