EapPeerGetResult function (eapmethodpeerapis.h)

Article
10/13/2021

Obtains the result of an authentication session from the EAP method.

This function is called when a method has completed authentication, or when the lower layer receives an alternative result.

Syntax

DWORD EapPeerGetResult(
  [in]  EAP_SESSION_HANDLE        sessionHandle,
  [in]  EapPeerMethodResultReason reason,
  [out] EapPeerMethodResult       *ppResult,
  [out] EAP_ERROR                 **ppEapError
);

Parameters

[in] sessionHandle

A pointer to an EAP_SESSION_HANDLE structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionHandle parameter in a previous call to EapPeerBeginSession.

[in] reason

A EapPeerMethodResultReason structure that specifies the reason code for the authentication result returned in ppResult.

[out] ppResult

A pointer to a EapPeerMethodResult structure that contains the authentication results.

[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 passing a pointer to EapPeerFreeErrorMemory.

Return value

None

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 Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	eapmethodpeerapis.h