• Article

AgentProfile.Description Property

Gets or sets a textual description of the replication agent profile.

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 AgentProfile
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 agent profile.

Remarks

The Description property is a read/write property.

The Description property can be retrieved only by members of the sysadmin fixed server role at the Distributor or by members of the replmonitor fixed database role.

The Description property can be set only by members of the sysadmin fixed server role at the Distributor.

Retrieving Description is equivalent to executing sp_help_agent_profile (Transact-SQL).

Setting Description for an existing profile and calling CommitPropertyChanges is equivalent to executing sp_change_agent_profile (Transact-SQL).

Setting Description and calling Create is equivalent to executing sp_add_agent_profile (Transact-SQL).

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.