RasEapBegin

[This is preliminary documentation and subject to change.]

The RAS Connection Manager calls the RasEapBegin function to initialize an authentication session.

DWORD ( *RasEapBegin )( 
  VOID *          ppWorkBuffer,  // buffer used in subsequent calls to protocol
  PPP_EAP_INPUT * pPppEapInput   // initialization information 
);
 

Parameters

ppWorkBuffer

Pointer to a pointer that, on successful return, points to a work buffer. This buffer is opaque to RAS; the contents of the buffer are used only by the authentication protocol. The RAS Connection Manager will pass a pointer to this buffer to the authentication protocol in subsequent calls to RasEapMakeMessage.

pPppEapInput

Pointer to to a PPP_EAP_INPUT structure that contains initialization information for the authentication session.

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

The RasEapBegin function is not part of the Routing and RAS API; it is implemented in the Extensible Authentication Protocol (EAP) DLL. When the RAS Connection Manager 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 *ppWorkBuffer) is allocated by the authentication protocol. The authentication protocol should free this memory in its implementation of RasEapEnd.

QuickInfo

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

See Also

RasEapEnd, RasEapGetInfo, RasEapMakeMessage, PPP_EAP_INFO, PPP_EAP_INPUT