Share via

EapHostPeerGetResult (Compact 2013)

  • Article

3/26/2014

Obtains the authentication result for the specified EAP authentication session.

Syntax

DWORD APIENTRY EapHostPeerGetResult(
  __in   EAP_SESSIONID sessionHandle,
  __in   EapHostPeerMethodResultReason reason,
  __out  EapHostPeerMethodResult* ppResult,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • sessionHandle
    A pointer to an EAP_SESSIONID structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionId parameter in a previous call to EapHostPeerBeginSession.
  • ppResult
    A pointer to a EapHostPeerMethodResultReason structure that contains the authentication results. EAPHost fills this structure with authentication related information defined in EapHostPeerMethodResult.
  • ppEapError
    A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before the code calls this function. If error data is available, a pointer to the address of an EAP_ERROR structure that contains any errors raised during the execution of this function call is received. After using the error data, free this memory by calling EapHostPeerFreeEapError.

Remarks

The supplicant calls EapHostPeerGetResult on completion of an authentication that can occur in any of the following scenarios.

  • A call to EapHostPeerProcessReceivedPacket returned the EapHostPeerResponseResult action code.
  • The client timed out and wants to get the result based on the current state.
  • The supplicant received another result, perhaps from a packet on the lower layer.

See Also

Reference

EAPHost Supplicant Run-time Functions
EapHostPeerProcessReceivedPacket