Export (0) Print
Expand All

StepCompletionAction Enumeration

 

Applies To: SQL Server 2016 Preview

The StepCompletionAction enumeration contains values that specify the action taken on completion of a job step.

Namespace:   Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.SqlEnum (in Microsoft.SqlServer.SqlEnum.dll)

public enum StepCompletionAction

Member nameDescription
GoToNextStep

When the referenced job step completes the next job step is executed.

GoToStep

When the referenced job step completes the specified job step is executed.

QuitWithFailure

When the referenced job step completes the job completes execution with a status of failure.

QuitWithSuccess

When the referenced job step completes the job completes execution with a status of success.

If your job is designed so that after performing one job step successfully it moves on to perform the next job step in the sequence, you should set OnSuccessAction to GoToNextStep. If you want to jump to a job step that is out of sequence, you will have to use F:Microsoft.SqlServer.Management.Smo.Agent.StepCompletionAction.GoToStep, and then specify which job step number to jump to. For example, if a job step fails, you might want to jump to another job step to manage the failure. To do this, set the OnFailAction to GoToStep and then set the OnFailStep to the integer value that matches the ID property of the JobStep.

The StepCompletionAction enumeration class is served by the OnSuccessAction property and the OnFailAction property.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft