Share via


RasEapInitialize (Compact 2013)

3/26/2014

This function is called by RAS to initialize or deinitialize the authentication protocol.

Syntax

DWORD RasEapInitialize(
  BOOL fInitialize
);

Parameters

  • fInitialize
    [in] Specifies whether the authentication protocol should initialize or deinitialize. This parameter is TRUE if the protocol initializes and FALSE if the protocol does not initialize.

Return Value

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 RasEapInitialize function is not part of the RRAS API. It is implemented in the EAP DLL. When RAS calls the RasEapGetInfo function, it receives a PPP_EAP_INFO structure for the authentication protocol. This structure contains a pointer to the RasEapInitialize function.

The authentication protocol may set the RasEapInitialize member in PPP_EAP_INFO to NULL. A NULL value indicates that the authentication protocol does not require initialization or deinitialization. Therefore, RAS do not have to call this function.

Note

This function is called by the EAP module, not by the application. Therefore, no link library is exposed.

Requirements

Header

raseapif.h

See Also

Reference

EAP Functions
PPP_EAP_INFO
RasEapBegin
RasEapGetInfo