ISchedulerJob::Id property

Retrieves the job identifier.

This property is read-only.

Syntax

HRESULT get_Id(
  [out] long *pId
);

Property value

The job identifier.

Error codes

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code. To get a description of the error, access the ISchedulerJob::ErrorMessage property.

Remarks

The identifier is set when you call the IScheduler::AddJob method to add the job to the scheduler. The ISchedulerJob::SubmitJob method will also set the identifier if the job has not been added to the scheduler.

Examples

For an example, see Creating a Parametric Sweep Task.

Requirements

See also

ISchedulerJob