StepID 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 StepIDproperty is a user-defined, long integer identifying a SQL Server Agent job step.

Syntax

object.StepID [= 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 GetStepID(LPLONG pRetVal);
HRESULT SetStepID(long NewValue);

Remarks

When using SQL Distributed Management Objects (SQL-DMO) to define the steps of a job, set StepID as part of job step creation. A value specified for StepID is used to define the first step executed when SQL Server Agent runs the job, and it is used in properties controlling job step execution flow.

Applies To: