Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

AgentProfile.Description Property

 

Applies To: SQL Server 2016 Preview

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

Namespace:   Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

public string Description { get; set; }

Property Value

Type: System.String

A String value that contains a textual description of the agent profile.

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

Return to top
Show:
© 2015 Microsoft