EapHostPeerGetResult, fonction (eappapis.h)
Obtient le résultat de l’authentification pour la session d’authentification EAP spécifiée.
Syntaxe
DWORD EapHostPeerGetResult(
[in] EAP_SESSIONID sessionHandle,
[in] EapHostPeerMethodResultReason reason,
[out] EapHostPeerMethodResult *ppResult,
[out] EAP_ERROR **ppEapError
);
Paramètres
[in] sessionHandle
Pointeur vers une structure de EAP_SESSIONID qui contient le handle unique de cette session d’authentification EAP sur le serveur EAPHost. Ce handle est retourné dans le paramètre pSessionId d’un appel précédent à EapHostPeerBeginSession.
[in] reason
Valeur d’énumération EapHostPeerMethodResultReason qui spécifie le code de raison du résultat d’authentification retourné dans ppResult.
[out] ppResult
Pointeur vers une structure EapHostPeerMethodResultReason qui contient les résultats de l’authentification. EAPHost remplit cette structure avec des informations relatives à l’authentification définies dans EapHostPeerMethodResult.
[out] ppEapError
Pointeur vers l’adresse d’une structure EAP_ERROR . L’adresse doit avoir la valeur NULL avant d’appeler cette fonction. Si des données d’erreur sont disponibles, un pointeur vers l’adresse d’une structure de EAP_ERROR qui contient les erreurs générées pendant l’exécution de cet appel de fonction est reçu. Les demandeurs doivent faire référence à ce paramètre pour déterminer si l’authentification a réussi. Après avoir utilisé les données d’erreur, libérez cette mémoire en appelant EapHostPeerFreeEapError.
Valeur retournée
Si la fonction réussit, la valeur de retour est NO_ERROR. La valeur de retour n’indique pas si l’authentification a réussi. Les supplicants doivent faire référence au paramètre ppEapError pour déterminer le résultat de l’authentification.
Si la fonction échoue, la valeur de retour doit être un code d’erreur approprié de Winerror.h, Raserror.h ou Mprerror.h.
Remarques
Le demandeur appelle EapHostPeerGetResult à la fin d’une authentification, ce qui peut se produire dans l’un des scénarios suivants.
- Un appel à EapHostPeerProcessReceivedPacket a retourné le code d’action EapHostPeerResponseResult .
- Le client a expiré et souhaite obtenir le résultat en fonction de l’état actuel.
- Le demandeur a reçu un autre résultat, peut-être à partir d’un paquet sur la couche inférieure.
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows Vista [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows Server 2008 [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | eappapis.h |
| Bibliothèque | Eappprxy.lib |
| DLL | Eappprxy.dll |