EapMethodAuthenticatorBeginSession function

Creates a new EAP authentication session on the server EAPHost.

EapMethodAuthenticatorBeginSession is a function prototype.


DWORD EapMethodAuthenticatorBeginSession(
  _In_        DWORD              dwFlags,
  _In_         LPCWSTR           pwszIdentity,
  _In_  const EapAttributes      *pAttributeArray,
  _In_        DWORD              dwSizeOfConnectionData,
  _In_  const BYTE               *pConnectionData,
  _In_        DWORD              dwMaxSendPacketSize,
  _Out_       EAP_SESSION_HANDLE *pSessionHandle,
  _Out_       EAP_ERROR          **ppEapError


dwFlags [in]

A combination of EAP flags that describe the EAP authentication session behavior.

pwszIdentity [in]

A zero-terminated Unicode string that contains the identity of the user to authenticate.

pAttributeArray [in]

A pointer to an EapAttributes array structure that specifies the EAP attributes of the entity to authenticate.

dwSizeOfConnectionData [in]

Specifies the size, in bytes, of the connection data buffer provided in pConnectionData.

pConnectionData [in]

A pointer to a buffer that contains the opaque configuration data BLOB.

dwMaxSendPacketSize [in]

Specifies the maximum size, in bytes, of an EAP packet sent during the session.

pSessionHandle [out]

A pointer to an EAP_SESSION_HANDLE structure that contains the unique handle for this EAP authentication session on the EAPHost server.

ppEapError [out]

Optionally receives a pointer to a pointer to an EAP_ERROR structure that contains any errors raised by EAPHost during the execution of this function call. After consuming the error data, this memory must be freed by passing a pointer to the error data to EapMethodAuthenticatorFreeMemory.


This call is performed by a authenticator-based EAPHost using a function pointer to this API. This API must be implemented on the EAP authenticator method loaded by EAPHost, and must strictly conform to the syntax and parameter types specified in the documentation.


Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]



See also

EAPHost Authenticator Method Functions



Community Additions