EapHostPeerGetMethodProperties function (eaphostpeerconfigapis.h)

Article
02/22/2024

The EapHostPeerGetMethodProperties function is used to retrieve the properties of an EAP method given the connection and user data.

Syntax

DWORD EapHostPeerGetMethodProperties(
  [in]  DWORD                     dwVersion,
  [in]  DWORD                     dwFlags,
  [in]  EAP_METHOD_TYPE           eapMethodType,
  [in]  HANDLE                    hUserImpersonationToken,
  [in]  DWORD                     dwEapConnDataSize,
  [in]  const BYTE                *pbEapConnData,
  [in]  DWORD                     dwUserDataSize,
  [in]  const BYTE                *pbUserData,
  [out] EAP_METHOD_PROPERTY_ARRAY *pMethodPropertyArray,
  [out] EAP_ERROR                 **ppEapError
);

Parameters

[in] dwVersion

The version number of the API. Set this parameter to zero.

[in] dwFlags

A combination of EAP flags that describe the EAP authentication session behavior.

[in] eapMethodType

An EAP_METHOD_TYPE structure that specifies the EAP method the supplicant is to use.

[in] hUserImpersonationToken

A handle to the user impersonation token to use in this session.

[in] dwEapConnDataSize

The size, in bytes, of the connection data buffer provided in pbEapConnData.

[in] pbEapConnData

Connection data used for the EAP method. If set to NULL, the static property of the method, as configured in the registry, is returned.

[in] dwUserDataSize

The size, in bytes, of the user data buffer provided in pbUserData.

[in] pbUserData

A pointer to a byte buffer that contains the opaque user data BLOB. This parameter can be NULL.

[out] pMethodPropertyArray

A pointer to the method properties array EAP_METHOD_PROPERTY_ARRAY. Caller should free the inner pointers using EapHostPeerFreeMemory starting at the innermost pointer. The caller should free an empvString value only when the type is empvtString.

[out] ppEapError

A pointer to a pointer to 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 EapHostPeerFreeErrorMemory.

Return value

None

Remarks

EapHostPeerGetMethodProperties allows the user to retrieve the properties of an EAP method through the EAPHost supplicant interface. The properties returned by this API may be different from properties returned by the EapHostPeerGetMethods function. The EapHostPeerGetMethodProperties function returns the properties of an EAP method for a specific connection and user data.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	eaphostpeerconfigapis.h
Library	Eappcfg.lib
DLL	Eappcfg.dll