EapHostPeerInitialize function (eappapis.h)

Initializes an EAPHost authentication session.

The EapHostPeerInitialize function must be called before any other peer or supplicant function is called. If the EapHostPeerInitialize function fails, do not call any other EAPHost run-time API.

Note  The other EAPHost configuration APIs aren't affected by the failure of EAPHostPeerInitialize.

 

Syntax

DWORD EapHostPeerInitialize();

Return value

None

Remarks

EapHostPeerInitialize and EapHostPeerUninitialize are always thread safe.

The following call occurs within the EapHostPeerInitialize function:

CoInitializeEx(NULL, COINIT_MULTITHREADED);

The client should not initialize a conflicting COM environment. If different COM environment (such as a single-threaded apartment) is required, the client should call CoInitializeEx directly, and not call EapHostPeerInitialize. If CoInitializeEx is called directly, then the client must call CoUninitialize to uninitialize the session. In addition, the client must use COM functions (and not EAPHost supplicant functions) to allocate and free memory.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header eappapis.h
Library Eappprxy.lib
DLL Eappprxy.dll

See also

EAPHost Supplicant Run-time Functions

EapHostPeerUninitialize