EapHostPeerQueryUIBlobFromInteractiveUIInputFields function (eaphostpeerconfigapis.h)

The EapHostPeerQueryUIBlobFromInteractiveUIInputFields function converts user information into a user BLOB that can be consumed by EAPHost run-time functions.

Syntax

DWORD EapHostPeerQueryUIBlobFromInteractiveUIInputFields(
  [in]      DWORD                         dwVersion,
  [in]      DWORD                         dwFlags,
  [in]      DWORD                         dwSizeofUIContextData,
  [in]      const BYTE                    *pUIContextData,
  [in]      const EAP_INTERACTIVE_UI_DATA *pEapInteractiveUIData,
  [in, out] DWORD                         *pdwSizeOfDataFromInteractiveUI,
  [in, out] BYTE                          **ppDataFromInteractiveUI,
  [out]     EAP_ERROR                     **ppEapError,
  [in, out] LPVOID                        *ppvReserved
);

Parameters

[in] dwVersion

The version number of the API.

Value	Meaning
EAPHOST_PEER_API_VERSION 1	The version of the EAPHost Peer APIs.

[in] dwFlags

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

[in] dwSizeofUIContextData

The size of the context data in pUIContextData, in bytes.

[in] pUIContextData

Pointer to a BLOB that contains UI context data, represented as inner pointers to field data. These inner pointers must be freed by passing them to EapHostPeerFreeMemory, starting with the innermost pointer.

[in] pEapInteractiveUIData

Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive UI components raised on an EAP supplicant.

[in, out] pdwSizeOfDataFromInteractiveUI

A pointer to a DWORD that specifies the size, in bytes, of the buffer pointed to by ppDataFromInteractiveUI. If this value is not set to zero, then a pointer to a buffer of the size specified in this parameter must be supplied to ppDataFromInteractiveUI.

[in, out] ppDataFromInteractiveUI

Pointer that receives a credentials BLOB that can be used in authentication. The caller should free the inner pointers using the function EapHostPeerFreeMemory, starting at the innermost pointer. If a non-null value is supplied for this parameter (meaning that an existing data BLOB is passed to it), the supplied data BLOB will be updated and returned in this parameter. If a non-NULL BLOB value is supplied, the LocalAlloc function should be used.

[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 calling EapHostPeerFreeErrorMemory.

[in, out] ppvReserved

Reserved for future use. This parameter must be set to 0.

Return value

None

Remarks

Supplicant API Call Sequence.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eaphostpeerconfigapis.h
Library	Eappcfg.lib
DLL	Eappcfg.dll

See also

EAPHost Supplicant Configuration Functions

SSO and PLAP