Publication.StopSnapshotGenerationAgentJob Method

  • Article

Attempts to stop a running Snapshot Agent job.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Sub StopSnapshotGenerationAgentJob

public void StopSnapshotGenerationAgentJob ()

public:
void StopSnapshotGenerationAgentJob ()

public void StopSnapshotGenerationAgentJob ()

public function StopSnapshotGenerationAgentJob ()

Remarks

If the snapshot job is not already running, the StopSnapshotGenerationAgentJob method throws an exception.

The StopSnapshotGenerationAgentJob method can only be called by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

Publication Class
Publication Members
Microsoft.SqlServer.Replication Namespace