SQL-DMO
OnFailStep Property
The OnFailStep property identifies the SQL Server Agent job step executed after failure of the referenced step.
Applies To
| JobStep Object |
Syntax
object.OnFailStep [= value]
Parts
object
Expression that evaluates to an object in the Applies To list
value
Long integer that specifies a job step by ordinal number
Data Type
Long
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetOnFailStep(LPLONG pRetVal);
HRESULT SetOnFailStep(long NewValue);
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.
To direct job failure logic to a specific step
- Set OnFailStep to indicate the job step that should execute.
- Set the OnFailAction property to SQLDMOJobStepAction_GotoStep.