MergeSubscription.SynchronizationAgent Property

Definition

Gets an instance of the MergeSynchronizationAgent class that can be used to synchronize the subscription.

public:
 property Microsoft::SqlServer::Replication::MergeSynchronizationAgent ^ SynchronizationAgent { Microsoft::SqlServer::Replication::MergeSynchronizationAgent ^ get(); };
public Microsoft.SqlServer.Replication.MergeSynchronizationAgent SynchronizationAgent { get; }
member this.SynchronizationAgent : Microsoft.SqlServer.Replication.MergeSynchronizationAgent
Public ReadOnly Property SynchronizationAgent As MergeSynchronizationAgent

Property Value

MergeSynchronizationAgent

A MergeSynchronizationAgent object.

Remarks

Call the Synchronize method on the returned MergeSynchronizationAgent object to synchronize the subscription.

You should call CommitPropertyChanges to save any property changes on the server before retrieving SynchronizationAgent to synchronize the subscription.

If the subscription is created with a value of false for CreateSyncAgentByDefault, a Merge Agent job for the subscription is not created. You may need to specify additional properties on the returned MergeSynchronizationAgent object before it can be used to synchronize the subscription.

The SynchronizationAgent property can only be retrieved by members of the sysadmin fixed server role at the Publisher, members of the db_owner fixed database role on the publication database, or members of the publication access list for the publication to which the subscription belongs.

Retrieving SynchronizationAgent is equivalent to executing sp_helpmergesubscription.

Applies to