IMergeSynchronizationAgent Interface
Provides an implementation of the MergeSynchronizationAgent class for late-bound COM clients.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)
Syntax
'Declaration
<ComVisibleAttribute(True)> _
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)> _
<GuidAttribute("f7b73669-8742-4e3b-af40-9fed3f1cacab")> _
Public Interface IMergeSynchronizationAgent
'Usage
Dim instance As IMergeSynchronizationAgent
[ComVisibleAttribute(true)]
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)]
[GuidAttribute("f7b73669-8742-4e3b-af40-9fed3f1cacab")]
public interface IMergeSynchronizationAgent
[ComVisibleAttribute(true)]
[InterfaceTypeAttribute(ComInterfaceType::InterfaceIsDual)]
[GuidAttribute(L"f7b73669-8742-4e3b-af40-9fed3f1cacab")]
public interface class IMergeSynchronizationAgent
[<ComVisibleAttribute(true)>]
[<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)>]
[<GuidAttribute("f7b73669-8742-4e3b-af40-9fed3f1cacab")>]
type IMergeSynchronizationAgent = interface end
public interface IMergeSynchronizationAgent
The IMergeSynchronizationAgent type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AlternateSynchronizationPartnerCollection | Gets the alternate synchronization partners for a subscription. |
|
AltSnapshotFolder | Gets or sets the alternate snapshot folder for the subscription. |
|
ComErrorCollection | Gets a collection of errors generated by the replication agent. |
|
Distributor | Gets or sets the name of the instance of Microsoft SQL Server that is acting as the Distributor for the subscription. |
|
DistributorAddress | Gets or sets the network address that is used to connect to the Distributor when the DistributorNetwork property is specified. |
|
DistributorEncryptedPassword | Gets or sets the encrypted version of the Distributor password. |
|
DistributorLogin | Gets or sets the login name that is used when connecting to the Distributor using SQL Server Authentication. |
|
DistributorNetwork | Gets or sets the client Net-Library that is used when connecting to the Distributor. |
|
DistributorPassword | Gets or sets the password that is used when connecting to the Distributor using SQL Server Authentication. |
|
DistributorSecurityMode | Gets or sets the security mode used when connecting to the Distributor. |
|
DownloadGenerationsPerBatch | Gets or sets the number of generations to be processed in a single batch while downloading changes from the Publisher to the Subscriber. A generation is defined as a logical group of changes per article. |
|
DynamicSnapshotLocation | Gets or sets the location of the partitioned snapshot for this Subscriber. |
|
ExchangeType | Gets or sets how data is exchanged during synchronization. |
|
FileTransferType | Gets or sets how the initial snapshot files are transferred to the Subscriber. |
|
HostName | Gets or sets the value used by the Merge Agent when it evaluates a parameterized filter that uses the HOST_NAME function. |
|
InputMessageFile | Gets or sets the name of the input message file. |
|
InternetLogin | Gets or sets the login name that is used with Web synchronization when connecting to the Publisher by using Internet authentication. |
|
InternetPassword | Gets or sets the password for the InternetLogin property that is used with Web synchronization when connecting to the Publisher by using Internet authentication. |
|
InternetProxyLogin | Gets or sets the login name that is used with Web synchronization when connecting to the Web server by using an Internet proxy server. |
|
InternetProxyPassword | Gets or sets the password for the login that is used with Web synchronization when connecting to the Web server by using an Internet proxy server. |
|
InternetProxyServer | Gets or sets the name of the Internet proxy server that is used with Web synchronization when connecting to the Web server. |
|
InternetSecurityMode | Gets or sets the HTTP authentication method that is used when connecting to the Web server during Web synchronization. |
|
InternetTimeout | Gets or sets the HTTP time-out when connecting to the Web server. |
|
InternetUrl | Gets or sets the URL of the Web service that is configured for Web synchronization. |
|
LastUpdatedTime | Gets the timestamp of the last time that replication agent synchronized the subscription. |
|
LoginTimeout | Gets or sets the maximum number of seconds to wait for connections to be established. |
|
MetadataRetentionCleanup | Get or sets whether to clean up metadata. |
|
Output | Gets or sets the agent output file. |
|
OutputMessageFile | Gets or sets the name of the output message file. |
|
OutputVerboseLevel | Gets or sets the level of detail of information that is written to the agent output file. |
|
ProfileName | Gets or sets the name of the profile that is used by the agent. |
|
Publication | Gets or sets the name of the publication. |
|
Publisher | Gets or sets the name of the instance of Microsoft SQL Server that is the Publisher for the subscription. |
|
PublisherAddress | Gets or sets the network address that is used to connect to the Publisher when the PublisherNetwork property is specified. |
|
PublisherChanges | Gets the total number of Publisher changes that were applied at the Subscriber during the last synchronization. |
|
PublisherConflicts | Gets the total number of conflicts that occurred at the Publisher during the last synchronization. |
|
PublisherDatabase | Gets or sets the name of the publication database. |
|
PublisherEncryptedPassword | Gets or sets the publisher encrypted password. |
|
PublisherFailoverPartner | Gets or sets the failover partner instance of SQL Server that is participating in a database mirroring session with the publication database. |
|
PublisherLogin | Gets or sets the login name that is used when connecting to the Publisher by using SQL Server Authentication. |
|
PublisherNetwork | Gets or sets the client Net-Library that is used when connecting to the Publisher. |
|
PublisherPassword | Gets or sets the password that is used when connecting to the Publisher by using SQL Server Authentication. |
|
PublisherSecurityMode | Gets or sets the security mode that is used when connecting to the Publisher. |
|
QueryTimeout | Gets or sets the number of seconds that are allowed for internal queries to finish. |
|
Subscriber | Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. |
|
SubscriberChanges | Gets the total number of Subscriber changes that were applied at the Publisher during the last synchronization. |
|
SubscriberConflicts | Gets the total number of conflicts that occurred at the Publisher during the last synchronization. |
|
SubscriberDatabase | Gets or sets the name of the subscription database. |
|
SubscriberDatabasePath | Gets or sets the subscriber database path. |
|
SubscriberDataSourceType | Gets or sets the type of data source that is used as the Subscriber. |
|
SubscriberEncryptedPassword | Gets or sets the subscriber encrypted password. |
|
SubscriberLogin | Gets or sets the login name used that is when connecting to the Subscriber by using SQL Server Authentication. |
|
SubscriberPassword | Sets the password that is used when connecting to the Subscriber by using SQL Server Authentication. |
|
SubscriberSecurityMode | Gets or sets the security mode used when connecting to the Subscriber. |
|
SubscriptionType | Gets or sets whether the subscription is a push or pull subscription. |
|
SyncToAlternate | Gets or sets whether the synchronization is to an alternate synchronization partner. |
|
UploadGenerationsPerBatch | Gets or sets the number of generations to be processed in a single batch while uploading changes from the Subscriber to the Publisher. A generation is defined as a logical group of changes per article. |
|
UseInteractiveResolver | Gets or sets whether the interactive resolver is used during reconciliation. |
|
UseWebSynchronization | Gets or sets whether Web synchronization is used. |
|
Validate | Gets or sets whether data validation is performed on the Subscriber data at the end of the synchronization. |
|
WorkingDirectory | Gets or sets the working directory from which snapshot files are accessed when FTP is used. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Abort | Aborts the current subscription synchronization. |
|
ClearAllTraceFlags | Clears all the trace flags used in the synchronization. |
|
ClearTraceFlag | Clears the specified trace flag. |
|
EnableTraceFlag | Enables the specified trace flag. |
|
IsSnapshotRequired | Gets or sets a value that indicates whether a new snapshot will be applied during the next agent synchronization. |
|
ProcessMessagesAtPublisher | Processes the messages at the publisher. |
|
ProcessMessagesAtSubscriber | Processes the messages at the subscriber. |
|
Synchronize | Starts the Merge Agent to synchronize the subscription. |
Top
Remarks
See MergeSynchronizationAgent for information on members of IMergeSynchronizationAgent.