EapPeerGetMethodProperties function

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 WINAPI EapPeerGetMethodProperties(
  _In_        DWORD                     dwVersion,
  _In_        DWORD                     dwFlags,
  _In_        EAP_METHOD_TYP            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

dwVersion [in]

The version number of the API.

dwFlags [in]

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

eapMethodType [in]

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

hUserImpersonationToken [in]

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

dwEapConnDataSize [in]

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

pbEapConnData [in]

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

dwUserDataSize [in]

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

pbUserData [in]

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

pMethodPropertyArray [out]

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.

ppEapError [out]

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.

Requirements

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Eapmethodpeerapis.h

DLL

Eappcfg.dll

 

 

Community Additions

ADD
Show: