Skip to main content

Windows Dev Center

EapPeerGetConfigBlobAndUserBlob function

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 WINAPI 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

dwFlags [in]

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

eapMethodType [in]

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

eapCredential [in]

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

pdwConfigBlobSize [out]

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

ppConfigBlob [out]

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

pdwUserBlobSize [out]

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

ppUserBlob [out]

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

ppEapError [out]

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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Eapmethodpeerapis.h

DLL

Eappcfg.dll

See also

EAP_ERROR
EAP_METHOD_TYPE
EapCredential
EAP flags
EapPeerFreeErrorMemory