EapPeerGetInfo function (eapmethodpeerapis.h)

Obtains a set of function pointers for an implementation of the EAP peer method EapPeerGetInfo currently loaded on the EAPHost service.

Syntax

DWORD EapPeerGetInfo(
  [in]  EAP_TYPE                 *pEapType,
  [out] EAP_PEER_METHOD_ROUTINES *pEapInfo,
  [out] EAP_ERROR                **ppEapError
);

Parameters

[in] pEapType

A pointer to an EAP_TYPE structure that contains the vendor data on the implementer of the APIs pointed to by the members of this structure.

[out] pEapInfo

A pointer to an EAP_PEER_METHOD_ROUTINES structure that contains the function pointers to EAP method-specific implementations of the APIs that correspond to supplicant calls made to the peer-based EAPHost.

[out] ppEapError

A pointer to a pointer to an EAP_ERROR structure that receives 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

Remarks

Every EAP peer method DLL must implement the following APIs:

• EapPeerInitialize
• EapPeerBeginSession
• EapPeerGetIdentity
• EapPeerSetCredentials
• EapPeerProcessRequestPacket
• EapPeerGetResponsePacket
• EapPeerGetResult
• EapPeerGetUIContext
• EapPeerSetUIContext
• EapPeerGetResponseAttributes
• EapPeerSetResponseAttributes
• EapPeerEndSession
• EapPeerShutdown

These APIs correspond to calls made by a supplicant, and serve as a proxy between the supplicant's API calls and the public APIs exposed on the EAP method DLL. Therefore, when a supplicant makes a call to a peer-based EAPHost to establish an authentication session or to perform an operation during that session, the EAPHost calls the corresponding implemented function on the EAP method DLL with the parameters provided. The EAP method functions are managed by pointers to their respective entry points.

The other functions in the EAP Peer Method API set are called by a peer-based EAPHost without a corresponding supplicant call, and are used for connection validation or user interface invocation operations.

This call is performed by a peer-based EAPHost using a function pointer to this API. This API must be implemented on the EAP method loaded by EAPHost, and must strictly conform to the syntax and parameter types specified in the documentation.

Requirements

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

See also

EAPHost Peer Method Run-Time Functions