EapPeerQueryUIBlobFromInteractiveUIInputFields function (eapmethodpeerapis.h)
The EapPeerQueryUIBlobFromInteractiveUIInputFields function converts user information into a user BLOB that can be consumed by EAPHost run-time functions.
Syntax
DWORD 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,
[in, out] LPVOID *ppvReserved
);
Parameters
[in] dwVersion
The version number of the API. Must be set to zero.
[in] dwFlags
A combination of EAP flags that describe the EAP authentication session behavior.
[in] dwSizeofUIContextData
The size of the context data in the pUIContextData parameter, in bytes.
[in] 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.
[in] pEapInteractiveUIData
Pointer that receives an EAP_INTERACTIVE_UI_DATA structure that contains configuration information for interactive user interface components raised on an EAP supplicant.
[out] 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, then a pointer to a buffer of the size specified in this parameter must be supplied in the ppDataFromInteractiveUI parameter.
[out] ppDataFromInteractiveUI
A pointer that receives a credentials BLOB that can be used in authentication. The caller should free the inner pointers using the function EapPeerFreeMemory, 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.
[out] 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 consuming the error data, this memory must be freed by calling EapPeerFreeErrorMemory.
[in, out] ppvReserved
Reserved for future use. This parameter must be set to 0.
Return value
None
Remarks
Peer Method 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 | eapmethodpeerapis.h |