RasEapGetInfo

  • Article

This function is called by RAS to obtain a set of function pointers for a specified authentication protocol.

DWORD RasEapGetInfo(
  DWORD dwEapTypeId,
  PPP_EAP_INFO* pEapInfo
);

Parameters

  • dwEapTypeId
    [in] Specifies the authentication protocol for which to obtain information.
  • pEapInfo
    [out] Pointer to a PPP_EAP_INFO structure. The structure receives members that RAS sets to identify the structure version and the authentication protocol for which function pointers are requested.

Return Values

If the function call succeeds, the return value is NO_ERROR.

If the function call fails, it returns an appropriate error code from Winerror.h, Raserror.h, or Mprerror.h.

Remarks

The dynamic-link library (DLL) that implements RasEapGetInfo may support more than one authentication protocol. The dwEapTypeId parameter specifies for which authentication protocol to obtain information.

Implementations of EAP must export the RasEapGetInfo function, because RAS uses RasEapGetInfo to obtain pointers to the other authentication protocol functions.

Upon initialization, RAS calls RasEapGetInfo for each EAP DLL installed in the registry subkey.

If the function returns any value other than NO_ERROR, RAS considers the authentication protocol to be nonfunctional. RAS posts an error to the event log indicating that this protocol did not start correctly and therefore is not available.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Raseapif.h.
Link Library: This function is called by the EAP module, not by the application. Therefore, no link library is exposed. For more information, see EAP Implementation Details.

See Also

PPP_EAP_INFO

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.