Share via


Publication.StopSnapshotGenerationAgentJob Method

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
'Usage
Dim instance As Publication

instance.StopSnapshotGenerationAgentJob()
public void StopSnapshotGenerationAgentJob()
public:
void StopSnapshotGenerationAgentJob()
member StopSnapshotGenerationAgentJob : unit -> unit 
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.