ICredentialProviderCredential::Advise method (credentialprovider.h)

Article
02/22/2024

Enables a credential to initiate events in the Logon UI or Credential UI through a callback interface. This method should be called before other methods in ICredentialProviderCredential interface.

Syntax

HRESULT Advise(
  [in] ICredentialProviderCredentialEvents *pcpce
);

Parameters

[in] pcpce

Type: ICredentialProviderCredentialEvents*

A pointer to an ICredentialProviderCredentialEvents callback interface to be used as the notification mechanism.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

This method is optional. If you do not implement this method, you should just return E_NOTIMPL.

Credential providers that implement this method have the responsibility of calling AddRef on the provided ICredentialProviderCredentialEvents. Those credential providers also need to call Release during the UnAdvise method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	credentialprovider.h