ITransSynchronizationAgent Interface

Provides an implementation of the TransSynchronizationAgent class for late-bound COM clients.

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

Syntax

'Declaration
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)> _
<ComVisibleAttribute(True)> _
<GuidAttribute("2e9eb2da-1dbc-4bea-aa2e-db0eb9d94344")> _
Public Interface ITransSynchronizationAgent
'Usage
Dim instance As ITransSynchronizationAgent
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)]
[ComVisibleAttribute(true)]
[GuidAttribute("2e9eb2da-1dbc-4bea-aa2e-db0eb9d94344")]
public interface ITransSynchronizationAgent
[InterfaceTypeAttribute(ComInterfaceType::InterfaceIsDual)]
[ComVisibleAttribute(true)]
[GuidAttribute(L"2e9eb2da-1dbc-4bea-aa2e-db0eb9d94344")]
public interface class ITransSynchronizationAgent
[<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)>]
[<ComVisibleAttribute(true)>]
[<GuidAttribute("2e9eb2da-1dbc-4bea-aa2e-db0eb9d94344")>]
type ITransSynchronizationAgent =  interface end
public interface ITransSynchronizationAgent

The ITransSynchronizationAgent type exposes the following members.

Properties

  Name Description
Public property AltSnapshotFolder Gets or sets the alternate snapshot folder for the subscription.
Public property ComErrorCollection Gets a collection of errors that are generated by the replication agent.
Public property Distributor Gets or sets the name of the instance of Microsoft SQL Server that is acting as the Distributor for the subscription.
Public property DistributorAddress Gets or sets the network address that is used to connect to the Distributor when the DistributorNetwork property is specified.
Public property DistributorEncryptedPassword Gets or sets the encrypted password associated with the distributor.
Public property DistributorLogin Gets or sets the login name that is used when connecting to the Distributor by using SQL Server Authentication.
Public property DistributorNetwork Gets or sets the client Net-Library that is used when connecting to the Distributor.
Public property DistributorPassword Sets the password that is used when connecting to the Distributor by using SQL Server Authentication.
Public property DistributorSecurityMode Gets or sets the security mode that is used when connecting to the Distributor.
Public property 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.
Public property 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.
Public property FileTransferType Gets or sets how the initial snapshot files are transferred to the Subscriber.
Public property HostName Gets or sets the hostname associated with the agent.
Public property LastUpdatedTime Gets the timestamp of the last time that replication agent synchronized the subscription.
Public property LoginTimeout Gets or sets the maximum number of seconds to wait for connections to be established.
Public property MaxDeliveredTransactions Gets or sets the maximum number of transactions that are applied to the Subscriber during a single agent execution.
Public property Output Gets or sets the file name and path of the agent output file.
Public property OutputVerboseLevel Gets or sets the amount of information that is logged by the Distribution Agent in the agent output file.
Public property ProfileName Gets or sets the name of the profile that is used by the agent.
Public property Publication Gets or sets the name of the publication.
Public property Publisher Gets or sets the name of the instance of Microsoft SQL Server that is the Publisher for the subscription.
Public property PublisherDatabase Gets or sets the name of the publication database.
Public property QueryTimeout Gets or sets the number of seconds that are allowed for internal queries to complete.
Public property SkipErrors Gets or sets a colon-separated list of the error numbers that are to be skipped by this agent.
Public property Subscriber Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.
Public property SubscriberDatabase Gets or sets the name of the subscription database.
Public property SubscriberDatabasePath Gets or sets the path of the subscription database.
Public property SubscriberDataSourceType Gets or sets the type of data source that is used as the Subscriber.
Public property SubscriberEncryptedPassword Gets or sets the encrypted password associated with the subscriber.
Public property SubscriberLogin Gets or sets the login name that is used when connecting to the Subscriber by using SQL Server Authentication.
Public property SubscriberPassword Gets or sets the password that is used when connecting to the Subscriber by using SQL Server Authentication.
Public property SubscriberSecurityMode Gets or sets the security mode that is used when connecting to the Publisher.
Public property SubscriptionType Gets or sets whether the subscription is a push or pull subscription.
Public property UndeliveredCommands Gets the number of undelivered commands for the agent.
Public property UndeliveredTransactions Gets the number of undelivered transactions for the agent.
Public property UseInProcLoader Gets or sets whether to use the BULK INSERT command when applying snapshot files at the Subscriber.
Public property WorkingDirectory Gets or sets the working directory from which snapshot files are accessed when File Transfer Protocol (FTP) is used.

Top

Methods

  Name Description
Public method Abort Aborts the operation of ITransSynchronizationAgent.
Public method IsSnapshotRequired Specifies whether a new snapshot will be applied during the next agent synchronization.
Public method Synchronize Starts the Distribution Agent to synchronize the subscription.

Top

Remarks

See TransSynchronizationAgentfor information on members of ITransSynchronizationAgent.

See Also

Reference

Microsoft.SqlServer.Replication Namespace