OnSuccessAction Property

  • Article

Cette fonctionnalité sera supprimée dans une prochaine version de Microsoft SQL Server. Évitez d'utiliser cette fonctionnalité dans de nouveaux travaux de développement, et prévoyez de modifier les applications qui utilisent actuellement cette fonctionnalité.

The OnSuccessAction property controls the behavior of a SQL Server Agent job when the referenced step succeeds.

Syntaxe

object
.OnSuccessAction [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list.
  • value
    A long integer that specifies job logic as described in Settings.

Data Type

Long, enumerated

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetOnSuccessAction(SQLDMO_JOBSTEPACTION_TYPE* pRetVal);
HRESULT SetOnSuccessAction(SQLDMO_JOBSTEPACTION_TYPE NewValue);

Settings

Constant Value Description

SQLDMOJobStepAction_/GotoNextStep

3

Continues execution at the next sequential step.

SQLDMOJobStepAction_/GotoStep

4

Continues execution at the next identified step.

SQLDMOJobStepAction_/QuitWithFailure

2

Stops job execution, reporting failure.

SQLDMOJobStepAction_/QuitWithSuccess

1

Stops job execution, reporting success.

SQLDMOJobStepAction_/Unknown

0

Job step logic is unassigned for the referenced job step.

Notes

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.

When using SQLDMOJobStepAction_/GotoStep to direct execution to a specific step, set the OnSuccessStep property to identify the job step executed on success.

Applies To:

JobStep Object