AgentProfile.Description Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a textual description of the replication agent profile.
public:
property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };public string Description { get; set; }member this.Description : string with get, setPublic Property Description As StringProperty 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).