Edit

Share via

ICredentialProviderCredentialEvents::SetFieldCheckbox method (credentialprovider.h)

  • Article

Communicates to the Logon UI or Credential UI that a checkbox field has changed and that the UI should be updated.

Syntax

HRESULT SetFieldCheckbox(
  [in] ICredentialProviderCredential *pcpc,
  [in] DWORD                         dwFieldID,
  [in] BOOL                          bChecked,
  [in] LPCWSTR                       pszLabel
);

Parameters

[in] pcpc

Type: ICredentialProviderCredential*

The credential containing the checkbox field that is being set. This value should be set to this. See ICredentialProviderCredentialEvents for more information.

[in] dwFieldID

Type: DWORD

The unique field ID for the checkbox.

[in] bChecked

Type: BOOL

The new state of the checkbox. TRUE indicates the checkbox should be checked, FALSE indicates it should not.

[in] pszLabel

Type: LPCWSTR

The new string for the checkbox label.

Return value

Type: HRESULT

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

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