Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 4.33 KB

nf-credentialprovider-icredentialprovider-advise.md

File metadata and controls

89 lines (66 loc) · 4.33 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:credentialprovider.ICredentialProvider.Advise
ICredentialProvider::Advise (credentialprovider.h)
Allows a credential provider to initiate events in the Logon UI or Credential UI through a callback interface.
Advise
Advise method [Windows Shell]
Advise method [Windows Shell]
ICredentialProvider interface
ICredentialProvider interface [Windows Shell]
Advise method
ICredentialProvider.Advise
ICredentialProvider::Advise
credentialprovider/ICredentialProvider::Advise
shell.ICredentialProvider_Advise
shell_ICredentialProvider_Advise
shell\ICredentialProvider_Advise.htm
shell
5ca35c90-24a3-4ffe-abf7-ba3ce0ec83b9
12/05/2018
Advise, Advise method [Windows Shell], Advise method [Windows Shell],ICredentialProvider interface, ICredentialProvider interface [Windows Shell],Advise method, ICredentialProvider.Advise, ICredentialProvider::Advise, credentialprovider/ICredentialProvider::Advise, shell.ICredentialProvider_Advise, shell_ICredentialProvider_Advise
credentialprovider.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Credentialprovider.idl
Windows
19H1
ICredentialProvider::Advise
credentialprovider/ICredentialProvider::Advise
c++
APIRef
kbSyntax
COM
Credentialprovider.h
ICredentialProvider.Advise

ICredentialProvider::Advise

-description

Allows a credential provider to initiate events in the Logon UI or Credential UI through a callback interface.

-parameters

-param pcpe [in]

Type: ICredentialProviderEvents*

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

-param upAdviseContext [in]

Type: UINT_PTR

A pointer to an integer that uniquely identifies which credential provider has requested re-enumeration.

-returns

Type: HRESULT

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

-remarks

The method does not need to be implemented, and should return E_NOTIMPL if it doesn't. There might be no reason to call it, such as if the Logon UI or Credential UI never changes or updates.

This method enables the Logon UI and the Credential UI to pass an ICredentialProviderEvents pointer to the credential provider. This enables the credential provider to have asynchronous callback communication with the Logon or Credential UI. For example, a smart card provider might want to enumerate credentials again when a new smart card is inserted. In order to trigger the Logon UI to get credentials again, the credential provider should call CredentialsChanged providing the upAdviseContext identifier.

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

-see-also

ICredentialProvider

ICredentialProvider::UnAdvise