Export (0) Print
Expand All

EapHostPeerQueryCredentialInputFields function

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 WINAPI 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 **pEapError
);

Parameters

hUserImpersonationToken [in]

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

eapMethodType [in]

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

dwFlags [in]

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

dwEapConnDataSize [in]

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

pbEapConnData [in]

Connection data used for the EAP method.

pEapConfigInputFieldArray [out]

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.

pEapError [out]

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.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eaphostpeerconfigapis.h

Library

Eappcfg.lib

DLL

Eappcfg.dll

See also

EAPHost Supplicant Configuration Functions
SSO and PLAP

 

 

Community Additions

ADD
Show:
© 2014 Microsoft