ISchedulerJob::EmailAddress property

Retrieves or sets the email address to which the HPC Job Scheduler Service should send notifications when the job starts or finishes.

This property is read/write.

Syntax

HRESULT put_EmailAddress(
  [in]  BSTR emailAddress
);

HRESULT get_EmailAddress(
  [out] BSTR *pEmailAddress
);

Property value

Indicates the email address to which the HPC Job Scheduler Service should send notifications when the job starts or finishes.

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 ErrorMessage task property.

Remarks

The maximum length for the email address that you specify is 256 characters. The HPC Job Scheduler Service sends notifications to the user who created the job by default.

When you specify an email address for receiving notifications about a job, the notifications are not turned on automatically. You still need to set the ISchedulerJob::NotifyOnStart and/or ISchedulerJob::NotifyOnCompletion property to True to specify when you want to receive notifications about the job.

Requirements

See also

ISchedulerJob