ICredentialProviderCredentialWithFieldOptions::GetFieldOptions method (credentialprovider.h)

Retrieves the current option set for a specified field in a logon or credential UI. Called by the credential provider framework.

Syntax

HRESULT GetFieldOptions(
  [in]  DWORD                                        fieldID,
  [out] CREDENTIAL_PROVIDER_CREDENTIAL_FIELD_OPTIONS *options
);

Parameters

[in] fieldID

The ID of the field in the logon or credential UI.

[out] options

A pointer to an CREDENTIAL_PROVIDER_CREDENTIAL_FIELD_OPTIONS value that, when this method returns successfully, receives one or more flags that specify the current options for the field.

Return value

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

Requirements

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

See also

ICredentialProviderCredentialEvents2::SetFieldOptions

ICredentialProviderCredentialWithFieldOptions