TransSynchronizationAgent Class
Provides the functionality of the Replication Distribution Agent.
Assembly: Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)
System::MarshalByRefObject
Microsoft.SqlServer.Replication::TransSynchronizationAgent
| Name | Description | |
|---|---|---|
![]() | TransSynchronizationAgent() | Creates an instance of the TransSynchronizationAgent class. |
| Name | Description | |
|---|---|---|
![]() | AltSnapshotFolder | Gets or sets the alternate snapshot folder for the subscription. |
![]() | ComErrorCollection | Gets a collection of errors that are 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 | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the encrypted password that is used when connecting to the distributor by using SQL Server Authentication. |
![]() | DistributorLogin | Gets or sets the login name that is used when connecting to the distributor by 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 by using SQL Server Authentication. |
![]() | DistributorSecurityMode | Gets or sets the security mode that is used when connecting to the distributor. |
![]() | DtsPackageFileName | Gets or sets the name and path of a Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is used to transform command rowsets before they are applied to a Subscriber. |
![]() | DtsPackagePassword | Gets or sets the owner password that used to access the Microsoft SQL Server 2000 Data Transformation Services (DTS) package specified by the DtsPackageFileName property. |
![]() | FileTransferType | Gets or sets how the initial snapshot files are transferred to the Subscriber. |
![]() | HostName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the host name used. |
![]() | 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. |
![]() | MaxDeliveredTransactions | Gets or sets the maximum number of transactions that are applied to the Subscriber during a single agent execution. |
![]() | Output | Gets or sets the file name and path of the agent output file. |
![]() | OutputVerboseLevel | Gets or sets the amount of information that is logged by the Distribution Agent in 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. |
![]() | PublisherDatabase | Gets or sets the name of the publication database. |
![]() | QueryTimeout | Gets or sets the number of seconds that are allowed for internal queries to complete. |
![]() | SecureDistributorEncryptedPassword | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the secure encrypted password for the distributor. |
![]() | SecureSubscriberEncryptedPassword | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the secure encrypted password for the subscriber. |
![]() | SkipErrors | Gets or sets a colon-separated list of the error numbers that are to be skipped by this agent. |
![]() | Subscriber | Gets or sets the name of the instance of Microsoft SQL Server that is the subscriber. |
![]() | SubscriberDatabase | Gets or sets the name of the subscription database. |
![]() | SubscriberDatabasePath | This API supports the product infrastructure and is not intended to be used directly from your code. Get or sets the database path for the subscriber. |
![]() | SubscriberDataSourceType | Gets or sets the type of data source that is used as the subscriber. |
![]() | SubscriberEncryptedPassword | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the encrypted password for the subscriber. |
![]() | SubscriberLogin | Gets or sets the login name that is used when connecting to the subscriber by using SQL Server Authentication. |
![]() | SubscriberPassword | Gets or sets the password that is used when connecting to the subscriber by using SQL Server Authentication. |
![]() | SubscriberSecurityMode | Gets or sets the security mode that is used when connecting to the publisher. |
![]() | SubscriptionType | Gets or sets whether the subscription is a push or pull subscription. |
![]() | UndeliveredCommands | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the number of undelivered commands. |
![]() | UndeliveredTransactions | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the number of undelivered transactions. |
![]() | UseInProcLoader | Gets or sets a value that indicates whether to use the BULK INSERT command when applying snapshot files at the subscriber. |
![]() | WorkingDirectory | Gets or sets the working directory from which snapshot files are accessed when File Transfer Protocol (FTP) is used. |
| Name | Description | |
|---|---|---|
![]() | Abort() | This API supports the product infrastructure and is not intended to be used directly from your code. Aborts the TransSynchronizationAgent operation. |
![]() | CreateObjRef(Type^) | (Inherited from MarshalByRefObject.) |
![]() | Dispose() | This API supports the product infrastructure and is not intended to be used directly from your code. Releases all resources used by the current instance of the TransSynchronizationAgent class. |
![]() | Dispose(Boolean) | Releases all resources used by the TransSynchronizationAgent class. |
![]() | Equals(Object^) | (Inherited from Object.) |
![]() | Finalize() | This API supports the product infrastructure and is not intended to be used directly from your code. Finalizes the TransSynchronizationAgent.(Overrides Object::Finalize().) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetLifetimeService() | (Inherited from MarshalByRefObject.) |
![]() | GetType() | (Inherited from Object.) |
![]() | InitializeLifetimeService() | (Inherited from MarshalByRefObject.) |
![]() | IsSnapshotRequired() | Connects to the Distributor and the Subscriber to determine whether a new snapshot will be applied during the next agent synchronization. |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
![]() | Synchronize() | Starts the Distribution Agent to synchronize the subscription. |
![]() | ToString() | (Inherited from Object.) |
The TransSynchronizationAgent class supports the ability to programmatically synchronize subscriptions to transactional or snapshot publications.
In the following example, the Synchronize method is called on the instance of the TransSynchronizationAgent class that is accessed from the SynchronizationAgent property to synchronize the push subscription.
The TransSynchronizationAgent class does not support multithreaded apartments. You can specify a single-threaded apartment by declaring the [STAThread] attribute on the method that is the main entry point for the application. This is the default for Microsoft Windows-based applications that are created by using Microsoft Visual Studio.
Microsoft.SqlServer.Replication Namespace
How to: Synchronize a Pull Subscription (RMO Programming)
How to: Synchronize a Push Subscription (RMO Programming)
Replication Distribution Agent



