Share via

  • Article

AgentProfile.Name Property

Gets or sets the name of the replication agent profile.

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

Syntax

'Declaration
Public Property Name As String
    Get
    Set
'Usage
Dim instance As AgentProfile
Dim value As String

value = instance.Name

instance.Name = value

public string Name { get; set; }

public:
property String^ Name {
    String^ get ();
    void set (String^ value);
}

member Name : string with get, set

function get Name () : String
function set Name (value : String)

Property Value

Type: System.String
A String value that specifies the name.

Exceptions

Exception Condition
ApplicationException

When you set Name for an existing profile.
ArgumentException

When the string value that is being set is nulla null reference (Nothing in Visual Basic), contains nulla null reference (Nothing in Visual Basic) 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).

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