CREDENTIAL_PROVIDER_CREDENTIAL_FIELD_OPTIONS enumeration (credentialprovider.h)

Provides customization options for a single field in a logon or credential UI. Used by ICredentialProviderCredentialEvents2::SetFieldOptions and ICredentialProviderCredentialWithFieldOptions::GetFieldOptions.

Syntax

typedef enum CREDENTIAL_PROVIDER_CREDENTIAL_FIELD_OPTIONS {
  CPCFO_NONE = 0,
  CPCFO_ENABLE_PASSWORD_REVEAL = 0x1,
  CPCFO_IS_EMAIL_ADDRESS = 0x2,
  CPCFO_ENABLE_TOUCH_KEYBOARD_AUTO_INVOKE = 0x4,
  CPCFO_NUMBERS_ONLY = 0x8,
  CPCFO_SHOW_ENGLISH_KEYBOARD = 0x10
} ;

Constants

 
CPCFO_NONE
Value: 0
Default. Don't show the "password reveal" glyph, and use the standard on-screen keyboard layout.
CPCFO_ENABLE_PASSWORD_REVEAL
Value: 0x1
Display the "password reveal" glyph in a password entry box. When this glyph is held down by the user, the entry in the password box is shown in plain text. The glyph is shown here:

Password reveal glyph
CPCFO_IS_EMAIL_ADDRESS
Value: 0x2
The field will contain an e-mail address. The on-screen keyboard should be optimized for that input (showing the .com and @ keys on the primary keyboard layout). This option is used with Microsoft account credentials.
CPCFO_ENABLE_TOUCH_KEYBOARD_AUTO_INVOKE
Value: 0x4
When enabled, the touch keyboard will be automatically invoked. This should be set only on the CPFG_CREDENTIAL_PROVIDER_LOGO field.
CPCFO_NUMBERS_ONLY
Value: 0x8
The field will only allow numerals to be entered. The on-screen keyboard should be optimized for that input (showing only a number keypad on the primary keyboard layout). This should be set only on the CPFT_PASSWORD_TEXT field
CPCFO_SHOW_ENGLISH_KEYBOARD
Value: 0x10
Show the English keyboard.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Header credentialprovider.h

See also

ICredentialProviderCredentialEvents2::SetFieldOptions

ICredentialProviderCredentialWithFieldOptions::GetFieldOptions