ISnapshotGenerationAgent Interface

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

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

Syntax

'Declaration
<GuidAttribute("238AB2B8-C0CA-47FC-9949-B67D516259BF")> _
<ComVisibleAttribute(True)> _
<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)> _
Public Interface ISnapshotGenerationAgent
'Usage
Dim instance As ISnapshotGenerationAgent

[GuidAttribute("238AB2B8-C0CA-47FC-9949-B67D516259BF")]
[ComVisibleAttribute(true)]
[InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)]
public interface ISnapshotGenerationAgent

[GuidAttribute(L"238AB2B8-C0CA-47FC-9949-B67D516259BF")]
[ComVisibleAttribute(true)]
[InterfaceTypeAttribute(ComInterfaceType::InterfaceIsDual)]
public interface class ISnapshotGenerationAgent

[<GuidAttribute("238AB2B8-C0CA-47FC-9949-B67D516259BF")>]
[<ComVisibleAttribute(true)>]
[<InterfaceTypeAttribute(ComInterfaceType.InterfaceIsDual)>]
type ISnapshotGenerationAgent =  interface end

public interface ISnapshotGenerationAgent

The ISnapshotGenerationAgent type exposes the following members.

Properties

	Name	Description
	AbortPolicy	Gets or sets how running replication agent threads are terminated when an unanticipated shutdown occurs.
	BcpBatchSize	Gets or set the number of rows to send to the Distributor in a bulk copy operation.
	ComErrorCollection	Gets the information on errors that occur during agent execution.
	Distributor	Gets or sets the name of the instance of SQL Server acting as the Distributor for the publication.
	DistributorDeadlockPriority	Gets or sets the priority of the Snapshot Agent connection to the Distributor when a deadlock occurs.
	DistributorEncryptionLevel	Gets of sets the level of Secure Sockets Layer (SSL) encryption used by the Snapshot Agent when connecting to the Distributor.
	DistributorLogin	Gets or sets the login name used when connecting locally to the Distributor using SQL Server Authentication.
	DistributorNetworkLibrary	Gets or sets the distributor network library.
	DistributorPassword	Sets the password used when connecting locally to the Distributor using SQL Server Authentication.
	DistributorSecurityMode	Gets or sets the security mode used when connecting locally to the Distributor.
	DynamicFilterHostName	Gets or sets the value supplied to the HOST_NAME function used in a parameterized row filter.
	DynamicFilterLogin	Gets or sets the value supplied to the SUSER_SNAME function used in a parameterized row filter.
	DynamicSnapshotLocation	Gets or sets the location of the partitioned snapshot for a subscription to a merge publication that is defined based-on a parameterized row filter.
	FieldDelimiter	Gets or sets the character or character sequence that marks the end of a field in the SQL Server bulk-copy data file.
	HistoryVerboseLevel	Gets or sets the amount of history logged during agent execution.
	LoginTimeout	Get or sets the number of seconds before the login times out for connections made by the agent.
	MaxBcpThreads	Gets or sets the number of bulk copy operations that can be performed in parallel.
	MaxNetworkOptimization	Gets or sets whether out-of-partition deletes are sent to the Subscriber.
	Output	Get or sets the name and path of the agent output file.
	OutputVerboseLevel	Gets or sets the level of detail of information written to the agent output file.
	PacketSize	Gets or sets the packet size associated with the agent.
	ProfileName	Gets or sets an agent profile to use when running the agent.
	Publication	Gets or sets the name of the publication.
	Publisher	Gets or sets the name of the instance of SQL Server that is the Publisher.
	PublisherDatabase	Gets or sets the name of the publication database.
	PublisherDeadlockPriority	Gets or sets the priority of the Snapshot Agent connection to the Publisher when a deadlock occurs.
	PublisherEncryptionLevel	Gets of sets the level of Secure Sockets Layer (SSL) encryption used by the Snapshot Agent when connecting to the Distributor.
	PublisherLogin	Gets or sets the login name used when connecting to the Publisher using SQL Server Authentication.
	PublisherNetworkLibrary	Gets or sets the publisher network library.
	PublisherSecurityMode	Gets or sets the security mode used when connecting to the Publisher.
	QueryTimeout	Get or sets the number of seconds before a query times out.
	ReplicationType	Gets or sets the type of publication.
	RowDelimiter	Gets or sets the character or character sequence that marks the end of a row in the SQL Server bulk-copy data file.
	StartQueueTimeout	Gets or sets the time that the Snapshot Agent waits when the maximum number of concurrent partitioned snapshot processes for a merge publication are already running.
	Supports70Subscribers	Gets or sets whether the generated snapshot supports SQL Server 7.0 Subscribers.

Top

Methods

	Name	Description
	Abort	Aborts the agent operation.
	GenerateSnapshot	Starts the Snapshot Agent to generate the snapshot.
	ResetParametersToDefault	Restores the parameters to its default value.

Top

Remarks

See SnapshotGenerationAgent for information on members of ISnapshotGenerationAgent.

See Also

Reference

Microsoft.SqlServer.Replication Namespace