MergePullSubscription.SynchronizationAgent 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 an object that represents an instance of the Merge Agent 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.MergeSynchronizationAgentPublic ReadOnly Property SynchronizationAgent As MergeSynchronizationAgentProperty Value
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 pull subscription is created with a value of false for CreateSyncAgentByDefault, the default, 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 Subscriber or by members of the db_owner fixed database role on the subscription database.
Retrieving the SynchronizationAgent property is equivalent to executing sp_helpmergepullsubscription.