Publication.Description Property

Article
12/03/2008

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

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)

Property Value

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.

Thread Safety

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.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms