Share via

EapPeerQueryCredentialInputFields (Compact 2013)

  • Article

3/26/2014

This function defines the implementation of an EAP method-specific function that obtains the EAP Single-Sign-On (SSO) credential input fields for an EAP method.

Syntax

DWORD WINAPI EapPeerQueryCredentialInputFields(
  __in   HANDLE hUserImpersonationToken,
  __in   EAP_METHOD_TYPE eapMethodType,
  __in   DWORD dwFlags,
  __in   DWORD dwEapConnDataSize,
  __in   BYTE* pbEapConnData,
  __out  EAP_CONFIG_INPUT_FIELD_ARRAY* pEapConfigInputFieldsArray,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • hUserImpersonationToken
    An impersonation token for the user whose credentials are to be requested and obtained.
  • eapMethodType
    An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method that is used for authenticating the connection.
  • dwFlags
    A combination of EAP Method Flags that describe the EAP authentication session behavior.
  • dwEapConnDataSize
    The size of the EAP SSO configuration byte data pointed to by pbEapConnData, in bytes.
  • pbEapConnData
    A Pointer to an opaque byte buffer that contains the EAP configuration data BLOB.
  • ppEapError
    A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by passing a pointer to the error data to EapPeerFreeErrorMemory.

Remarks

EapPeerQueryCredentialInputFields supports SSO. This peer method function, just as EapPeerQueryUserBlobFromCredentialInputFields, is used only in an SSO scenario.

The EAP method-specific implementation of this function is called by EAPHost whenever a supplicant application calls EapHostPeerQueryCredentialInputFields. The implementer of this function is responsible for ensuring that the EAP_CONFIG_INPUT_FIELD_ARRAY returned by this function contains input field definitions for each piece of credential data the EAP methods will request from the supplicant user.

See Also

Reference

EAPHost Peer Method Configuration Functions
EAP_CONFIG_INPUT_FIELD_ARRAY