IScheduler::SetEmailCredentials method

  • Article

Sets the email credentials by using the specified username and password.

Syntax

HRESULT SetEmailCredentials(
  [in] BSTR *userName,
  [in] BSTR *password
);

Parameters

  • userName [in]
    The user name.

  • password [in]
    The password.

Return value

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

Email credentials use the username and password of the email account as credentials for submitting jobs. To delete the email credentials, use the IScheduler::DeleteEmailCredentials method.

Requirements

Product

This method was introduced in Microsoft HPC Pack 2012 and is not supported in previous versions.

Type library

 Microsoft.Hpc.Scheduler.tlb