EapMethodAuthenticatorBeginSession function (eapmethodauthenticatorapis.h)

Creates a new EAP authentication session on the server EAPHost.

EapMethodAuthenticatorBeginSession is a function prototype.

Syntax

DWORD EapMethodAuthenticatorBeginSession(
  [in]  DWORD                       dwFlags,
  [in]  BYTE                        bInitialId,
        LPCWSTR                     pwszIdentity,
  [in]  const EapAttributes * const pAttributeArray,
  [in]  DWORD                       dwSizeofConnectionData,
        const BYTE * const          pConnectionData,
  [in]  DWORD                       dwMaxSendPacketSize,
  [out] EAP_SESSION_HANDLE          *pSessionHandle,
  [out] EAP_ERROR                   **ppEapError
);

Parameters

[in] dwFlags

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

[in] bInitialId

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

pwszIdentity

Identity of the user being authenticated.

[in] pAttributeArray

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

[in] dwSizeofConnectionData

Specifies the size in bytes of the data pointed to by pConnectionData. If pConnectionData is NULL, this member is zero.

pConnectionData

Pointer to connection data received from the authentication protocol's configuration user interface.

[in] dwMaxSendPacketSize

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

[out] pSessionHandle

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

[out] ppEapError

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.

Return value

None

Remarks

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.

Requirements

See also

EAPHost Authenticator Method Functions

EapHostPeerBeginSession