CREDENTIAL_PROVIDER_FIELD_STATE enumeration (credentialprovider.h)

  • Article

Specifies the state of a single field in the Credential UI. Used by CREDENTIAL_PROVIDER_FIELD_DESCRIPTOR and ICredentialProviderCredentialEvents::SetFieldState. The behavior of fields may vary depending on the current field state.

Syntax

typedef enum _CREDENTIAL_PROVIDER_FIELD_STATE {
  CPFS_HIDDEN = 0,
  CPFS_DISPLAY_IN_SELECTED_TILE,
  CPFS_DISPLAY_IN_DESELECTED_TILE,
  CPFS_DISPLAY_IN_BOTH
} CREDENTIAL_PROVIDER_FIELD_STATE;

Constants

 
CPFS_HIDDEN
Value: 0
Do not show the field in any state. One example of this would be a password edit control that should not be displayed until the user authenticates a thumb print. Until the thumb print has been authenticated, the state of the password field would be CPFS_HIDDEN.
CPFS_DISPLAY_IN_SELECTED_TILE
Show the field when in the selected state.
CPFS_DISPLAY_IN_DESELECTED_TILE
Show the field when in the deselected state. This value is only valid for a CREDENTIAL_PROVIDER_USAGE_SCENARIO is set to CPUS_CREDUI.
CPFS_DISPLAY_IN_BOTH
Show the field both when the credential tile is selected and when it is not selected.

Requirements

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