RasEapBegin callback function
The RAS connection manager calls the RasEapBegin function to initiate an authentication session.
Syntax
DWORD APIENTRY RasEapBegin(
_Out_ VOID **ppWorkBuffer,
_In_ PPP_EAP_INPUT *pPppEapInput
);
Parameters
ppWorkBuffer [out]
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 passes a pointer to this buffer to the authentication protocol in subsequent calls to RasEapMakeMessage.pPppEapInput [in]
Pointer to a PPP_EAP_INPUT structure that specifies initialization information for the authentication session.
Return value
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 RRAS API; it is implemented in the 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.
For more information, see Avoiding Buffer Overruns.
Requirements
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
Raseapif.h |
See also
Extensible Authentication Protocol Reference