RasEapInitialize

  • Article

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

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 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 RasEapInitialize function is not part of the RRAS application programming interface (API); it is implemented in the EAP dynamic-link library (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 need not call this function.

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 | RasEapBegin | RasEapGetInfo

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.