Partager via

EapPeerQueryUIBlobFromInteractiveUIInputFields (Compact 2013)

  • Article

3/26/2014

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

Syntax

DWORD WINAPI EapPeerQueryUIBlobFromInteractiveUIInputFields(
  __in     DWORD dwVersion,
  __in     DWORD dwFlags,
  __in     DWORD dwSizeofUIContextData,
  __in     const BYTE* pUIContextData,
  __in     const EAP_INTERACTIVE_UI_DATA* pEapInteractiveUIData,
  __out    DWORD* pdwSizeOfDataFromInteractiveUI,
  __out    BYTE** ppDataFromInteractiveUI,
  __out    EAP_ERROR** ppEapError,
  __inout  LPVOID* ppvReserved
);

Parameters

  • dwVersion
    The version number of the API. Must be set to 0 (zero).
  • dwFlags
    A combination of EAP Method Flags that describe the EAP authentication session behavior.
  • dwSizeofUIContextData
    The size of the context data in the pUIContextData parameter, in bytes.
  • pUIContextData
    A pointer to a BLOB that contains UI context data, represented as inner pointers to field data. The supplicant obtained these inner pointers from EAPHost run-time functions.
  • pEapInteractiveUIData
    Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive user interface components raised on an EAP supplicant.
  • pdwSizeOfDataFromInteractiveUI
    A pointer to a DWORD that specifies the size of the buffer pointed to by the ppDataFromInteractiveUI parameter, in bytes. If this value is not set to 0, a pointer to a buffer of the size specified in this parameter must be supplied in the ppDataFromInteractiveUI parameter.
  • ppDataFromInteractiveUI
    A pointer that receives a credentials BLOB that can be used in authentication. The caller should free the inner pointers by 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.
  • ppEapError
    A pointer to the address of 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 calling EapHostPeerFreeErrorMemory.
  • ppvReserved
    Reserved; set to 0 (zero).

Remarks

EapPeerQueryUIBlobFromInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). In an SSO scenario, EapPeerQueryUIBlobFromInteractiveUIInputFields is the last API to be called before resuming a regular call sequence.

See Also

Reference

EAPHost Peer Method Configuration Functions
EAPHost Supplicant Configuration Functions