IMailSyncCallBack::RequestCredentials

Article
08/28/2006

If the existing credentials are not valid, the RequestCredentials method allows the transports to request new credentials from the user. Messaging displays a dialog to the user for new credentials and returns the result of user interaction back to the transport.

Syntax

HRESULT RequestCredentials (
  LPCWSTR pszProfile,
  SYNCCREDENTIALS * ppcredsSource,
  SYNCCREDENTIALS ** ppcreds
);

Parameters

pszProfile
[in] The profile string that is passed into the transport when it is initialized.
ppcredsSource
[in] Reference to a SYNCCREDENTIALS structure that contains values to initialize the credentials dialog box.
ppcreds
[out] Reference to a new SYNCCREDENTIALS structure that contains the updated set of credentials.

Return Values

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

S_OK
Indicates if the user has entered new credentials and selected "OK."

Remarks

Transports must use IMailSyncCallBack::FreeMem to free this memory.

Requirements

Pocket PC: Pocket PC 2002 and later
Smartphone: Smartphone 2002 and later
OS Versions: Windows CE 3.0 and later
Header: cemapi.h
Library: cemapi.lib

Share via