EapHostPeerQueryCredentialInputFields function (eaphostpeerconfigapis.h)

Allows the user to determine what kind of credentials are required by the methods to perform authentication in a Single-Sign-On (SSO) scenario.

Syntax

DWORD EapHostPeerQueryCredentialInputFields(
  [in]  HANDLE                       hUserImpersonationToken,
  [in]  EAP_METHOD_TYPE              eapMethodType,
  [in]  DWORD                        dwFlags,
  [in]  DWORD                        dwEapConnDataSize,
  [in]  const BYTE                   *pbEapConnData,
  [out] EAP_CONFIG_INPUT_FIELD_ARRAY *pEapConfigInputFieldArray,
  [out] EAP_ERROR                    **ppEapError
);

Parameters

[in] hUserImpersonationToken

A handle to the user impersonation token to use in this session.

[in] eapMethodType

An EAP_METHOD_TYPE structure that identifies the EAP method the supplicant is to use.

[in] dwFlags

A combination of EAP flags that describe the EAP authentication session behavior.

[in] dwEapConnDataSize

The size, in bytes, of the connection data buffer provided in pbEapConnData.

[in] pbEapConnData

Connection data used for the EAP method.

[out] pEapConfigInputFieldArray

A pointer to an EAP_METHOD_INFO_ARRAY structure for installed EAP methods. The caller should free the inner pointers using the function EapHostPeerFreeMemory, starting at the innermost pointer.

[out] ppEapError

A pointer to a pointer to an EAP_ERROR structure that contains any errors raised by EAPHost during the execution of this function call. After consuming the error data, this memory must be freed by passing a pointer to EapHostPeerFreeErrorMemory.

Return value

None

Remarks

EapHostPeerQueryCredentialInputFields supports Single-Sign-On (SSO). This supplicant function, like EapHostPeerQueryUserBlobFromCredentialInputFields, is used only in an SSO scenario.

EapHostPeerQueryCredentialInputFields obtains the fields to be displayed in the UI during the session. The input fields are obtained to display data entered by the user in the SSO UI. The EAP_CONFIG_INPUT_FIELD_ARRAY structure returned contains details on how to display the input fields.

After EapHostPeerQueryCredentialInputFields, EAPHost calls EapHostPeerQueryUserBlobFromCredentialInputFields.

Requirements

See also

EAPHost Supplicant Configuration Functions

SSO and PLAP