GetJobByID Method

SQL-DMO

SQL-DMO

GetJobByID Method

The GetJobByID method returns a SQL-DMO Job object referencing the SQL Server Agent job identified by the specified job identifier.

Applies To
JobServer Object
Syntax

object.GetJobByID( Name , [ Flag ] ) as Job

Parts

object

Expression that evaluates to an object in the Applies To list.

Name

String representation of a SQL Server Agent job identifier.

Flag

When TRUE, the GetJobByID method queries an instance of Microsoft® SQL Server™ 2000 for the most recent copy of the job. When FALSE (default) and the application has cached the define jobs in a collection, only the cached collection is searched.

Prototype (C/C++)

HRESULT GetJobByID(
SQLDMO_LPCSTR szName,
LPSQLDMOJOB* ppJob,
BOOL bFlag = FALSE);

Returns

A Job object

Remarks

SQL Server Agent jobs are uniquely identified by a system-generated identifier. The identifier is a 32-character string representing a hexadecimal number and is visible in the JobID property of a SQL-DMO Job object.