Share via

RasEapBegin (Compact 2013)

  • Article

3/26/2014

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

Syntax

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 successive calls to the RasEapMakeMessage function.
  • pPppEapInput
    [in] Pointer to a PPP_EAP_INPUT structure that specifies initialization information for the authentication session.

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

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