Partager via


GetJobByID Method

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 GetJobByID method returns a SQL Distributed Management Objects (SQL-DMO) Job object referencing the SQL Server Agent job identified by the specified job identifier.

Syntaxe

object
.GetJobByID(
Name
, [ Flag ] )asJob

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 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.

Notes

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.

Applies To: