EapMethodAuthenticatorGetInfo function (eapmethodauthenticatorapis.h)

Obtains a set of function pointers for an implementation of the loaded EAP authenticator method.EapMethodAuthenticatorGetInfo is a function prototype.

Syntax

DWORD EapMethodAuthenticatorGetInfo(
  [in]  EAP_METHOD_TYPE                   *pEapType,
  [out] EAP_AUTHENTICATOR_METHOD_ROUTINES *pEapInfo,
  [out] EAP_ERROR                         **ppEapError
);

Parameters

[in] pEapType

A pointer to an EAP_METHOD_TYPE structure that contains the vendor ID of the EAPHost authenticator function implementer.

[out] pEapInfo

A pointer to an EAP_AUTHENTICATOR_METHOD_ROUTINES structure that contains the function pointers to EAP method-specific implementations of the APIs that correspond to specific RPC calls that can be made by EAP peer method functions.

[out] ppEapError

A pointer to the address of 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 the error data to EapMethodAuthenticatorFreeErrorMemory.

Return value

None

Remarks

Every EAP authenticator method DLL must have public implementations of the following APIs on it:

• EapMethodAuthenticatorInitialize
• EapMethodAuthenticatorBeginSession
• EapMethodAuthenticatorUpdateInnerMethodParams
• EapMethodAuthenticatorReceivePacket
• EapMethodAuthenticatorSendPacket
• EapMethodAuthenticatorGetAttributes
• EapMethodAuthenticatorSetAttributes
• EapMethodAuthenticatorGetResult
• EapMethodAuthenticatorEndSession
• EapMethodAuthenticatorShutdown

These APIs are called on an EAP authenticator method when an authenticator (server) EAPHost receives a specific corresponding RPC call from a peer (client) EAP method. Note that a complete one-to-one correspondence does not exist between EAP peer methods and EAP authenticator methods; the specific EAP authenticator method API calls should be made based on the requirements of your implementation of the EAP authenticator method API calls.

This call is performed by a authenticator-based EAPHost using a function pointer to this API. This API must be implemented on the EAP authenticator 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	eapmethodauthenticatorapis.h

See also

EAPHost Authenticator Method Functions