MergeSubscription.SynchronizationAgent Property

Artikkeli
12/03/2008

Gets an instance of the MergeSynchronizationAgent class 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

public MergeSynchronizationAgent SynchronizationAgent { get; }

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

/** @property */
public MergeSynchronizationAgent get_SynchronizationAgent ()

public function get SynchronizationAgent () : MergeSynchronizationAgent

Property 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 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.

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