Share via


AgentProfile.Name Property

Definition

Gets or sets the name of the replication agent profile.

public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };
public string Name { get; set; }
member this.Name : string with get, set
Public Property Name As String

Property Value

A String value that specifies the name.

Exceptions

When you set Name for an existing profile.

When the string value that is being set is null, contains null characters, or is longer than 128-Unicode characters.

Remarks

The Name property is a read/write property, and it is necessary to set this property before the object is created. Once the profile has been created on the server, this property cannot be changed.

The Name 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 Name property can be set only by members of the sysadmin fixed server role at the Distributor when a new profile is being created on the server.

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

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

Applies to

See also