ICredentialProviderCredentialEvents interface (credentialprovider.h)
Provides an asynchronous callback mechanism used by a credential to notify it of state or text change events in the Logon UI or Credential UI.
Inheritance
The ICredentialProviderCredentialEvents interface inherits from the IUnknown interface. ICredentialProviderCredentialEvents also has these types of members:
Methods
The ICredentialProviderCredentialEvents interface has these methods.
| ICredentialProviderCredentialEvents::AppendFieldComboBoxItem Communicates to the Logon UI or Credential UI that a combo box needs an item appended and that the UI should be updated. |
| ICredentialProviderCredentialEvents::DeleteFieldComboBoxItem Communicates to the Logon UI or Credential UI that an item should be deleted from a combo box and that the UI should be updated. |
| ICredentialProviderCredentialEvents::OnCreatingWindow Called when the window is created. Enables credentials to retrieve the HWND of the parent window after Advise is called. |
| ICredentialProviderCredentialEvents::SetFieldBitmap Communicates to the Logon UI or Credential UI that a tile image field has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldCheckbox Communicates to the Logon UI or Credential UI that a checkbox field has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldComboBoxSelectedItem Communicates to the Logon UI or Credential UI that the selected item in a combo box has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldInteractiveState Communicates to the Logon UI or Credential UI that the interactivity state of a field has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldState Communicates to the Logon UI or Credential UI that a field state has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldString Communicates to the Logon UI or Credential UI that the string associated with a field has changed and that the UI should be updated. |
| ICredentialProviderCredentialEvents::SetFieldSubmitButton Enables credentials to set the field that the submit button appears adjacent to. |
Remarks
These methods should only be called by a credential passing this as the first parameter. Behavior is undefined if you attempt to call these methods using a credential other than the one activated by the call on Advise. If a credential provider has information on another thread and wants to communicate through that thread's Logon UI or Credential UI, the requests will need to go through the credential that received the Advise call.
When to Implement
Third parties do not implement ICredentialProviderCredentialEvents. An implementation is included with Windows.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 |
See also
Credential Providers in Windows 10
ICredentialProviderCredential::Advise