RasEapGetInfo

[This is preliminary documentation and subject to change.]

The RAS Connection Manager calls RasEapGetInfo to obtain a set of function pointers for a specified authentication protocol.

DWORD RasEapGetInfo( 
  PPP_EAP_INFO * pEapInfo    // pointer to info for a particular EAP 
);
 

Parameters

pEapInfo

Pointer to a PPP_EAP_INFO structure. The structure contains members that RAS will set to identify the structure version and the authentication protocol for which function pointers are requested. For more information, see PPP_EAP_INFO.

Return Values

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value should be an appropriate error code from winerror.h, raserror.h, or mprerror.h.

Remarks

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

Upon initialization, the RAS Connection Manager Service will call RasEapGetInfo for each EAP DLL installed in the registry subkey, as explained in the EAP Overview.

If the function returns any value other than NO_ERROR, RAS will consider the authentication protocol to be non-functional. RAS will post an error to the Microsoft® Windows NT® Event Log indicating that this protocol did not start correctly and therefore is not available.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in raseapif.h.

See Also

EAP (Extensible Authentication Protocol) Overview, PPP_EAP_INFO