EapPeerGetConfigBlobAndUserBlob function (eapmethodpeerapis.h)

Article
02/22/2024

The EapPeerGetConfigBlobAndUserBlob method allows EAP method developers to provide the various connection properties and user properties supported by the method. EAPHost invokes this function to create the connection property and user property of the EAP method.

Syntax

DWORD EapPeerGetConfigBlobAndUserBlob(
  [in]  DWORD           dwFlags,
  [in]  EAP_METHOD_TYPE eapMethodType,
  [in]  EapCredential   eapCredential,
  [out] DWORD           *pdwConfigBlobSize,
  [out] BYTE            **ppConfigBlob,
  [out] DWORD           *pdwUserBlobSize,
  [out] BYTE            **ppUserBlob,
  [out] EAP_ERROR       **ppEapError
);

Parameters

[in] dwFlags

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

[in] eapMethodType

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

[in] eapCredential

An EapCredential structure that contains the credential type and the appropriate credentials.

[out] pdwConfigBlobSize

Receives a pointer to the size, in bytes, of the ppConfigBlob parameter.

[out] ppConfigBlob

Receives a pointer to a pointer that contains a byte buffer with configured connection data.

[out] pdwUserBlobSize

Receives a pointer to the size, in bytes, of the ppUserBlob parameter.

[out] ppUserBlob

Receives a pointer to a pointer that contains a byte buffer with the methods' user data.

[out] ppEapError

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 calling EapPeerFreeErrorMemory.

Return value

This function should return ERROR_SUCCESS when it is able to generate the correct connection and user blob. In all other cases, it returns the appropriate windows error.

Remarks

This call is performed by a peer-based EAPHost using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly conform to the syntax and parameter types specified in the documentation.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	eapmethodpeerapis.h
DLL	Eappcfg.dll