EapHostPeerQueryUIBlobFromInteractiveUIInputFields (Compact 2013)
3/26/2014
This function converts user information into a user BLOB that can be consumed by EAPHost run-time functions.
Syntax
DWORD WINAPI EapHostPeerQueryUIBlobFromInteractiveUIInputFields(
__in DWORD dwVersion,
__in DWORD dwFlags,
__in DWORD dwSizeofUIContextData,
__in const BYTE* pUIContextData,
__in EAP_INTERACTIVE_UI_DATA* pEapInteractiveUIData,
__inout DWORD* pdwSizeOfDataFromInteractiveUI,
__inout PBYTE* ppDataFromInteractiveUI,
__out EAP_ERROR** ppEapError,
__inout LPVOID* ppvReserved
);
Parameters
- dwVersion
The version number of the API.
Value |
Meaning |
|---|---|
EAPHOST_PEER_API_VERSION 1 |
The version of the EAPHost Peer APIs. |
- dwFlags
A combination of EAP Method Flags that describe the EAP authentication session behavior.
- dwSizeofUIContextData
The size of the context data in pUIContextData, in bytes.
- 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.
- pEapInteractiveUIData
Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive UI components raised on an EAP supplicant.
- 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.
- ppDataFromInteractiveUI
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. If a non-NULL BLOB value is supplied, the LocalAlloc function should be used.
- 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 using the error data, this memory must be freed by calling EapHostPeerFreeErrorMemory.
- ppvReserved
Reserved; set to 0 (zero).
Remarks
EapHostPeerQueryUIBlobFromInteractiveUIInputFields can be employed to support Single-Sign-On (SSO). In an SSO scenario, EapHostPeerQueryUIBlobFromInteractiveUIInputFields is the last API to be called before resuming a regular call sequence.