EapPeerSetCredentials function (eapmethodpeerapis.h)

Supplies new or updated authentication credentials to the EAP method.

Syntax

DWORD EapPeerSetCredentials(
  [in]  EAP_SESSION_HANDLE sessionHandle,
  [in]  LPWSTR             pwszIdentity,
  [in]  LPWSTR             pwszPassword,
  [out] EAP_ERROR          **ppEapError
);

Parameters

[in] sessionHandle

A pointer to an EAP_SESSION_HANDLE structure that contains the unique handle for this EAP authentication session on the EAPHost server. This handle is returned in the pSessionHandle parameter in a previous call to EapPeerBeginSession.

[in] pwszIdentity

A pointer that specifies the user identity for which to set the credentials. This user identity string is obtained by calling the EapPeerGetIdentity function.

[in] pwszPassword

A pointer that contains the clear text password for the user identity.

[out] ppEapError

A pointer to a pointer to an EAP_ERROR structure that contains any errors raised during the execution of this function call. After consuming the error data, this memory must be freed by calling EapPeerFreeErrorMemory.

Return value

None

Remarks

If the registry key InvokeUserNameDlg is set, EapPeerSetCredentials should be exported. If the registry key InvokeUserNameDlg is not set, EapPeerSetCredentials should export the EapPeerGetIdentity and EapPeerInvokeIdentityUI functions.

This call is performed by a peer-based EAPHost 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 specified in the documentation.

Requirements

See also

EAPHost Peer Method Run-Time Functions

EapPeerGetIdentity

EapPeerInvokeIdentityUI

EapPeerSetCredentials