Share via


EapPeerBeginSession (Compact 2013)

3/26/2014

Starts an EAP authentication session on the peer EAPHost by using the EAP method.

Syntax

DWORD WINAPI EapPeerBeginSession(
  __in   DWORD dwFlags,
  __in   const EapAttributes* pAttributeArray,
  __in   HANDLE hTokenImpersonateUser,
  __in   DWORD dwSizeofConnectionData,
  __in   BYTE* pConnectionData,
  __in   DWORD dwSizeofUserData,
  __in   BYTE* pUserData,
  __in   DWORD dwMaxSendPacketSize,
  __out  EAP_SESSION_HANDLE* pSessionHandle,
  __out  EAP_ERROR** ppEapError
);

Parameters

  • dwFlags
    A combination of EAP Method Flags that describe the new EAP authentication session behavior.
  • pAttributeArray
    A pointer to an EAP_ATTRIBUTES array structure that specifies the EAP attributes of the entity to authenticate.
  • hTokenImpersonateUser
    Specifies a handle to the user impersonation token to use in this session.
  • dwSizeofConnectionData
    Specifies the size, in bytes, of the connection data buffer provided in pConnectionData.
  • pConnectionData
    Connection data that is specific to this method that is used to decide the user data returned from this API, where the user data depends on certain connection data configuration. When this parameter is NULL the method implementation should use default values for connection.
  • dwSizeofUserData
    Specifies the size in bytes of the of the user data buffer provided in pUserData.
  • pUserData
    A pointer to a byte buffer that contains the opaque user data BLOB.
  • dwMaxSendPacketSize
    Specifies the maximum size in bytes of an EAP packet sent during the session. If the method needs to send a packet larger than the maximum size, the method must accommodate fragmentation and reassembly.
  • pSessionHandle
    A pointer to an EAP_SESSION_HANDLE structure that contains the unique handle for this EAP authentication session on the EAPHost server.
  • ppEapError
    A pointer to a pointer to an EAP_ERROR structure that contains any errors raised during the execution of this function call. After using the error data, this memory must be freed by calling EapPeerFreeErrorMemory.

Remarks

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

See Also

Reference

EAPHost Peer Method Run-Time Functions
EapPeerEndSession