RetryAttempts 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 RetryAttempts property specifies a number of times SQL Server Agent attempts to execute the referenced job step before reporting step failure.

Syntax

object.RetryAttempts [= value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list

  • value
    A long integer

Data Type

Long

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetRetryAttempts(LPLONG pRetVal);
HRESULT SetRetryAttempts(long NewValue);

Remarks

SQL Server Agent job steps are assigned simple logic determining job execution behavior on step success or failure.

If the job step completes successfully on any attempt numbered less than or equal to the value of the RetryAttemptsproperty, job execution branches to follow the on-success action for the step. If execution attempts exceed the value of the RetryAttemptsproperty, job execution branches to follow the on-failure action for the step.

If a job step fails and the step is flagged for retry, SQL Server Agent can pause between execution attempts. For more information, see RetryInterval Property.

Applies To: