JobID Property

SQL-DMO

SQL-DMO

JobID Property

The JobID property is a string representing the unique identifier of a SQL Server Agent job.

Applies To
Alert Object JobHistoryFilter Object
Job Object  
Syntax

object.JobID [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String representation of a globally unique identifier

Data Type

String

Modifiable

Read/write for the Alert and JobHistoryFilter objects. Read-only for the Job object.

Prototype (C/C++)

HRESULT GetJobID(SQLDMO_LPBSTR pRetVal);

HRESULT SetJobID(SQLDMO_LPCSTR NewValue);

Note  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 by using SysFreeString.

Remarks

Each SQL Server Agent job is identified by a system-generated, globally unique identifier. The identifier is a 32-character string representing a hexadecimal number.

For the Alert object, the JobID property represents the job identifier of the SQL Server Agent job run in response to the represented alert. The property is used to assign a job to an alert. The JobName property of the Alert object is read-only.

Setting the JobID property on the JobHistoryFilter object restricts the output of the EnumJobHistory method of the JobServer object. When used, the output includes only historical data for the identified SQL Server Agent job.