OnFailAction Property (SQL-DMO)

The OnFailAction property controls the behavior of a SQL Server Agent job when the referenced step fails execution.

Applies To

JobStep Object

Syntax

object.OnFailAction [= value]

Part Description
object Expression that evaluates to an object in the Applies To list
value Long integer specifying job logic as described in Settings

Settings
Constant Value Description
SQLDMOJobStepAction_
GotoStep
4 Continue execution at the next identified step
SQLDMOJobStepAction_
GotoNextStep
3 Continue execution at the next sequential step
SQLDMOJobStepAction_
QuitWithFailure
2 Terminate job execution, reporting failure
SQLDMOJobStepAction_
QuitWithSuccess
1 Terminate job execution, reporting success
SQLDMOJobStepAction_
Unknown
0 Job step logic is unassigned for the referenced job step

Remarks

On failure of a job step, SQL Server Agent can terminate the job (reporting success or failure) or, if the job has more than a single step, can attempt to execute the next step or another step in the job.

When using SQLDMOJobStepAction_GotoStep to direct execution to a specific step, set the OnFailStep property to identify the job step executed on failure.

Data Type

Long, enumerated.

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetOnFailAction(SQLDMO_JOBSTEPACTION_TYPE* pRetVal);

HRESULT SetOnFailAction(SQLDMO_JOBSTEPACTION_TYPE NewValue);

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.