Share via

JobStep.OnFailAction Property

  • Article

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
Public Property OnFailAction As StepCompletionAction

public StepCompletionAction OnFailAction { get; set; }

public:
property StepCompletionAction OnFailAction {
    StepCompletionAction get ();
    void set (StepCompletionAction value);
}

/** @property */
public StepCompletionAction get_OnFailAction ()

/** @property */
public void set_OnFailAction (StepCompletionAction value)

public function get OnFailAction () : StepCompletionAction

public function set OnFailAction (value : StepCompletionAction)

Property Value

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.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Example

How to: Create a Job with Steps and a Schedule in Visual Basic .NET

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

JobStep Class
JobStep Members
Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Scheduling Automatic Administrative Tasks in SQL Server Agent
Automating Administrative Tasks (SQL Server Agent)
sp_help_jobstep (Transact-SQL)