EapHostPeerQueryCredentialInputFields (Compact 2013)
3/26/2014
Lets the user 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 PBYTE pbEapConnData,
__out EAP_CONFIG_INPUT_FIELD_ARRAY* pEapConfigInputFieldArray,
__out EAP_ERROR** pEapError
);
Parameters
- hUserImpersonationToken
A handle to the user impersonation token to use in this session.
- eapMethodType
An EAP_METHOD_TYPE structure that identifies the EAP method the supplicant is to use.
- dwFlags
A combination of EAP flags that describe the EAP authentication session behavior.
- dwEapConnDataSize
The size, in bytes, of the connection data buffer provided in pbEapConnData.
- pbEapConnData
Connection data that is used for the EAP method.
- pEapConfigInputFieldArray
A pointer to an EAP_METHOD_INFO_ARRAY structure for installed EAP methods. The caller should free the inner pointers by using the function EapHostPeerFreeMemory, starting at the innermost pointer.
- pEapError
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 using the error data, this memory must be freed by passing a pointer to EapHostPeerFreeErrorMemory.
Remarks
EapHostPeerQueryCredentialInputFields supports Single-Sign-On (SSO). This supplicant function, such as 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 that is 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.