Share via

SnapshotGenerationAgent.GenerateSnapshot Method

  • Article

Starts the Snapshot Agent to generate the snapshot.

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

Syntax

'Declaration
Public Sub GenerateSnapshot
'Usage
Dim instance As SnapshotGenerationAgent

instance.GenerateSnapshot()

public void GenerateSnapshot()

public:
virtual void GenerateSnapshot() sealed

abstract GenerateSnapshot : unit -> unit  
override GenerateSnapshot : unit -> unit

public final function GenerateSnapshot()

Implements

ISnapshotGenerationAgent.GenerateSnapshot()

Exceptions

Exception Condition
ReplicationAgentException

When the Distributor or Publisher properties are not specified. When SQL Server Authentication is specified for a server connection but a login and password for the connection are not specified.

Examples

            // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2012";
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;

            SnapshotGenerationAgent agent;

            try
            {
                // Set the required properties for Snapshot Agent.
                agent = new SnapshotGenerationAgent();
                agent.Distributor = distributorName;
                agent.DistributorSecurityMode = SecurityMode.Integrated;
                agent.Publisher = publisherName;
                agent.PublisherSecurityMode = SecurityMode.Integrated;
                agent.Publication = publicationName;
                agent.PublisherDatabase = publicationDbName;
                agent.ReplicationType = ReplicationType.Transactional;

                // Start the agent synchronously.
                agent.GenerateSnapshot();

            }
            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "A snapshot could not be generated for the {0} publication."
                    , publicationName), ex);
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2012"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Transactional

    ' Start the agent synchronously.
    agent.GenerateSnapshot()

Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try

See Also

Reference

SnapshotGenerationAgent Class

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Create a Snapshot for a Merge Publication with Parameterized Filters (RMO Programming)

NIB Create the Initial Snapshot (RMO Programming)