CurrentRunStep 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 CurrentRunStep property reports the currently executing step of a SQL Server Agent job.

Syntax

object.CurrentRunStep

Parts

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

Data Type

String

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetCurrentRunStep(SQLDMO_LPBSTR pRetVal);

Note

SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

For executing jobs, the property reports the job step by number, and the name of the job step as a string, for example: 2 (Run Replication Agent)

CurrentRunStep is 0 (unknown) for idle jobs or whose execution status cannot be determined (CurrentRunStatus can be SQLDMOJobExecution_Idle, SQLDMOJobExecution_Suspended, or SQLDMOJobExecution_Unknown).

Applies To: