Subscription.SynchronizationAgentName Property

Article
12/03/2008

Gets or sets the name of the agent job created to synchronize the subscription.

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

Syntax

'Declaration
Public Property SynchronizationAgentName As String

public string SynchronizationAgentName { get; set; }

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

/** @property */
public String get_SynchronizationAgentName ()

/** @property */
public void set_SynchronizationAgentName (String value)

public function get SynchronizationAgentName () : String

public function set SynchronizationAgentName (value : String)

Property Value

A String value.

Remarks

The SynchronizationAgentName property is a read/write property on Microsoft SQL Server 2005. It is a ready-only property of Microsoft SQL Server 2000.

SynchronizationAgentName must be set before the subscription is created on the server. Once the subscription registration exists on the server, the SynchronizationAgentName property cannot be changed.

The SynchronizationAgentName property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by the user that created the subscription.

The SynchronizationAgentName property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.

Retrieving the SynchronizationAgentName property is equivalent to executing sp_helpsubscription or sp_helpmergesubscription.

Setting the SynchronizationAgentName property is equivalent to executing sp_addpushsubscription_agent or sp_addmergepushsubscription_agent.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

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