Export (0) Print
Expand All

EapPeerQueryCredentialInputFields 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 [in]

An impersonation token for the user whose credentials are to be requested and obtained.

eapMethodType [in]

An EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

dwFlags [in]

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

dwEapConnDataSize [in]

The size of the EAP SSO configuration byte data pointed to by pbEapConnData, in bytes.

pbEapConnData [in]

A Pointer to an opaque byte buffer that contains the EAP configuration data BLOB.

pEapConfigInputFieldsArray [out]

A Pointer to an EAP_CONFIG_INPUT_FIELD_ARRAY structure that contains the input fields to display to the supplicant user. The pwszData fields in the individual EAP_CONFIG_INPUT_FIELD_DATA elements are initialized to NULL.

ppEapError [out]

A pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After consuming 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, like 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 implementor 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.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eapmethodpeerapis.h

See also

EAP_CONFIG_INPUT_FIELD_ARRAY
SSO and PLAP

 

 

Community Additions

ADD
Show:
© 2014 Microsoft