Share via

  • Article

MergePullSubscription.SynchronizationAgent Property

Gets an object that represents an instance of the Merge Agent that can be used to synchronize the subscription.

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

Syntax

'Declaration
Public ReadOnly Property SynchronizationAgent As MergeSynchronizationAgent
    Get
'Usage
Dim instance As MergePullSubscription
Dim value As MergeSynchronizationAgent

value = instance.SynchronizationAgent

public MergeSynchronizationAgent SynchronizationAgent { get; }

public:
property MergeSynchronizationAgent^ SynchronizationAgent {
    MergeSynchronizationAgent^ get ();
}

member SynchronizationAgent : MergeSynchronizationAgent

function get SynchronizationAgent () : MergeSynchronizationAgent

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.

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