Share via

AgentProfile.Description Property

  • Article

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

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 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.

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

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

See Also

Reference

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Work with Replication Agent Profiles (RMO Programming)