EapHostPeerGetAuthStatus function (eappapis.h)
Obtains the supplicant's current EAP authentication status from EAPHost.
Syntax
DWORD EapHostPeerGetAuthStatus(
[in] EAP_SESSIONID sessionHandle,
[in] EapHostPeerAuthParams authParam,
[out] DWORD *pcbAuthData,
[out] BYTE **ppAuthData,
[out] EAP_ERROR **ppEapError
);
Parameters
[in] 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.
[in] authParam
An EapHostPeerAuthParams enumeration value that specifies the type of EAP authentication data to obtain from EAPHost.
Value | Meaning |
---|---|
|
ppAuthData contains a EAPHOST_AUTH_INFO structure. |
|
ppAuthData contains a WCHAR buffer. |
|
ppAuthData contains a CHAR buffer. |
|
Windows 7 or later: [EapHostPeerNapInfo](/windows/win32/eaphost/eaphostpeernapinfo) structure. |
[out] pcbAuthData
The size, in bytes, of the EAP authentication data buffer pointed to by the ppAuthData parameter.
[out] ppAuthData
A pointer to a pointer to a byte buffer that contains the authentication data from EAPHost. The format of this data depends on the value supplied in authParam.
[out] ppEapError
A pointer to the address of an EAP_ERROR structure. The address should be set to NULL before calling 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.
Return value
None
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2008 [desktop apps only] |
Target Platform | Windows |
Header | eappapis.h |
Library | Eappprxy.lib |
DLL | Eappprxy.dll |