EapPeerGetMethodProperties function (eapmethodpeerapis.h)

Defines the implementation of an EAP method-specific function that retrieves the properties of an EAP method given the connection and user data.

Syntax

DWORD EapPeerGetMethodProperties(
  [in]  DWORD                     dwVersion,
  [in]  DWORD                     dwFlags,
  [in]  EAP_METHOD_TYPE           eapMethodType,
  [in]  HANDLE                    hUserImpersonationToken,
  [in]  DWORD                     dwSizeOfConnectionDataIn,
  [in]  const BYTE                *pConnectionDataIn,
  [in]  DWORD                     dwSizeOfUserDataIn,
  [in]  const BYTE                *pUserDataIn,
  [out] EAP_METHOD_PROPERTY_ARRAY *pMethodPropertyArray,
  [out] EAP_ERROR                 **ppEapError
);

Parameters

[in] dwVersion

The version number of the API.

[in] dwFlags

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

[in] eapMethodType

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

[in] hUserImpersonationToken

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

[in] dwSizeOfConnectionDataIn

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

[in] pConnectionDataIn

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] dwSizeOfUserDataIn

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

[in] pUserDataIn

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 address of an EAP_ERROR structure that contains any errors raised during the execution of this function call. After consuming the error data, this memory must be freed by calling EapPeerFreeErrorMemory.

Return value

None

Requirements

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