Edit

Share via

ICredentialProviderCredential::GetFieldState method (credentialprovider.h)

  • Article

Retrieves the field state. The Logon UI and Credential UI use this to gain information about a field of a credential to display this information in the user tile.

Syntax

HRESULT GetFieldState(
  [in]  DWORD                                       dwFieldID,
  [out] CREDENTIAL_PROVIDER_FIELD_STATE             *pcpfs,
  [out] CREDENTIAL_PROVIDER_FIELD_INTERACTIVE_STATE *pcpfis
);

Parameters

[in] dwFieldID

Type: DWORD

The identifier for the field.

[out] pcpfs

Type: CREDENTIAL_PROVIDER_FIELD_STATE*

A pointer to the credential provider field state. This indicates when the field should be displayed on the user tile.

[out] pcpfis

Type: CREDENTIAL_PROVIDER_FIELD_INTERACTIVE_STATE*

A pointer to the credential provider field interactive state. This indicates when the user can interact with the field.

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