EapMethodAuthenticatorGetResult function (eapmethodauthenticatorapis.h)

Obtains the authentication result from the EAP authenticator method.

EapMethodAuthenticatorGetResult is a function prototype.

Syntax

DWORD EapMethodAuthenticatorGetResult(
  [in]  EAP_SESSION_HANDLE              sessionHandle,
  [out] EAP_METHOD_AUTHENTICATOR_RESULT *pResult,
  [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 EapMethodAuthenticatorBeginSession.

[out] pResult

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

[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 passing a pointer to the error data to EapMethodAuthenticatorFreeErrorMemory.

Return value

None

Remarks

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

Requirements

See also

EAPHost Authenticator Method Functions

EapMethodAuthenticatorBeginSession