JobStep.OnFailAction Property

Gets or sets the action to take when the job step finishes execution with failure.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property OnFailAction As StepCompletionAction
    Get
    Set
'Usage
Dim instance As JobStep
Dim value As StepCompletionAction

value = instance.OnFailAction

instance.OnFailAction = value
[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public StepCompletionAction OnFailAction { get; set; }
[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property StepCompletionAction OnFailAction {
    StepCompletionAction get ();
    void set (StepCompletionAction value);
}
[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member OnFailAction : StepCompletionAction with get, set
function get OnFailAction () : StepCompletionAction
function set OnFailAction (value : StepCompletionAction)

Property Value

Type: Microsoft.SqlServer.Management.Smo.Agent.StepCompletionAction
A StepCompletionAction object value that specifies the action to take when the referenced job step finishes execution with a completion status of failure.

Remarks

When a job step finishes execution it has status specified by the CompletionResult object value. This is recorded in the LastRunOutcome property for the job step when it was last executed. If the job step completed with failure, the next steps are determined by the OnFailAction property.