ONEX_EAP_ERROR structure (dot1x.h)
The ONEX_EAP_ERROR structure contains 802.1X EAP error when an error occurs with 802.1X authentication.
Syntax
typedef struct _ONEX_EAP_ERROR {
DWORD dwWinError;
EAP_METHOD_TYPE type;
DWORD dwReasonCode;
GUID rootCauseGuid;
GUID repairGuid;
GUID helpLinkGuid;
DWORD fRootCauseString : 1;
DWORD fRepairString : 1;
ONEX_VARIABLE_BLOB RootCauseString;
ONEX_VARIABLE_BLOB RepairString;
} ONEX_EAP_ERROR, *PONEX_EAP_ERROR;
Members
dwWinError
The error value defined in the Winerror.h header file. This member also sometimes contains the reason the EAP method failed. The existing values for this member for the reason the EAP method failed are defined in the Eaphosterror.h header file.
Some possible values are listed below.
type
The EAP method type that raised the error during 802.1X authentication. The EAP_METHOD_TYPE structure is defined in the Eaptypes.h header file.
dwReasonCode
The reason the EAP method failed. Some of the values for this member are defined in the Eaphosterror.h header file and some are defined in the Winerror.h header file, although other values are possible.
Possible values are listed below.
| Value | Meaning |
|---|---|
|
One or more arguments are not correct. |
|
The data is not valid. |
|
A parameter is incorrect. |
|
The EAPHost received EAP failure after the identity exchange. There is likely a problem with the authenticating user's account. |
|
Use FormatMessage to obtain the message string for the returned error. |
rootCauseGuid
A unique ID that identifies cause of error in EAPHost. An EAP method can define a new GUID and associate the GUID with a specific root cause. The existing values for this member are defined in the Eaphosterror.h header file.
repairGuid
A unique ID that maps to a localizable string that identifies the repair action that can be taken to fix the reported error. The existing values for this member are defined in the Eaphosterror.h header file.
helpLinkGuid
A unique ID that maps to a localizable string that specifies an URL for a page that contains additional information about an error or repair message. An EAP method can potentially define a new GUID and associate with one specific help link. Some of the existing values for this member are defined in the Eaphosterror.h header file.
fRootCauseString
Indicates if the ONEX_EAP_ERROR structure contains a root cause string in the RootCauseString member.
fRepairString
Indicates if the ONEX_EAP_ERROR structure contains a repair string in the RepairString member.
RootCauseString
A localized and readable string that describes the root cause of the error. This member contains a NULL-terminated Unicode string starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fRootCauseString bitfield member is set.
RepairString
A localized and readable string that describes the possible repair action. This member contains a NULL-terminated Unicode string starting at the dwOffset member of the ONEX_VARIABLE_BLOB if the fRepairString bitfield member is set.
Remarks
The ONEX_EAP_ERROR structure is used by the 802.1X module, a new wireless configuration component supported on Windows Vista and later.
Many members of the ONEX_EAP_ERROR structure correspond with similar members in the EAP_ERROR structure
The ONEX_RESULT_UPDATE_DATA contains information on a status change to 802.1X authentication. The ONEX_RESULT_UPDATE_DATA structure is returned when the NotificationSource member of the WLAN_NOTIFICATION_DATA structure is WLAN_NOTIFICATION_SOURCE_ONEX and the NotificationCode member of the WLAN_NOTIFICATION_DATA structure for received notification is OneXNotificationTypeResultUpdate. For this notification, the pData member of the WLAN_NOTIFICATION_DATA structure points to an ONEX_RESULT_UPDATE_DATA structure that contains information on the 802.1X authentication status change.
If the fEapError member in the ONEX_RESULT_UPDATE_DATA structure is set, then the eapError member of the ONEX_RESULT_UPDATE_DATA structure contains an ONEX_VARIABLE_BLOB structure with an ONEX_EAP_ERROR structure embedded starting at the dwOffset member of the ONEX_VARIABLE_BLOB.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Header | dot1x.h |