Share via

RasEapBegin

  • Article

This function is called by RAS to initiate an authentication session.

DWORD(*RasEapBegin)(
  VOID** ppWorkBuffer, 
  PPP_EAP_INPUT* pPppEapInput
);

Parameters

  • ppWorkBuffer
    [out] Pointer to a pointer that forwards data to a work buffer. The contents of the buffer are used only by the authentication protocol. RAS passes a pointer to this buffer to the authentication protocol in subsequent calls to the RasEapMakeMessage function.
  • pPppEapInput
    [in] Pointer to a PPP_EAP_INPUT structure that specifies initialization information for the authentication session.

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 RasEapBegin 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 RasEapBegin function.

The memory for the work buffer, pointed to by the ppWorkBufferparameter, is allocated by the authentication protocol. The authentication protocol should free this memory in its implementation of the RasEapEnd 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

RasEapEnd | RasEapGetInfo | RasEapMakeMessage | PPP_EAP_INFO | PPP_EAP_INPUT

 Last updated on Thursday, April 08, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.