OnSuccessStep Property
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The OnSuccessStep property identifies the SQL Server Agent job step executed after the success of the referenced step.
Syntax
object
.OnSuccessStep [= value]
Parts
- object
An expression that evaluates to an object in the Applies To list
- value
A long integer that specifies a job step by ordinal number
Data Type
Long
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetOnSuccessStep(LPLONG pRetVal);
HRESULT SetOnSuccessStep(long NewValue);
Remarks
On success of a job step, SQL Server Agent can stop the job (reporting success or failure), or if the job has more than a single step, it can attempt to execute the next step or another step in the job.
To direct job success logic to a specific step
Set OnSuccessStep to indicate the job step that should execute.
Set the OnSuccessAction property to SQLDMOJobStepAction_/GotoStep.
Applies To:
|