EapMethodAuthenticatorInvokeConfigUI function (eapmethodauthenticatorapis.h)

Defines a function that raises the EAP method's connection configuration user interface dialog box on the client.

EapMethodAuthenticatorInvokeConfigUI is a function prototype.

EapHostAuthenticatorInvokeConfigUI must be called on threads that have COM initialized for Single Threaded Apartment. This can be achieved by calling COM API CoInitialize; when the supplicant has finished with the STA thread CoUninitialize must be called before exiting.

Syntax

DWORD EapMethodAuthenticatorInvokeConfigUI(
  EAP_METHOD_TYPE *pEapMethodType,
  HWND            hwndParent,
  DWORD           dwFlags,
  LPCWSTR         pwszMachineName,
  DWORD           dwSizeOfConfigIn,
  BYTE            *pConfigIn,
  DWORD           *pdwSizeOfConfigOut,
  BYTE            **ppConfigOut,
  EAP_ERROR       **ppEapError
);

Parameters

pEapMethodType

A pointer to an EAP_METHOD_TYPE structure that contains vendor and author information about the EAP method used for authenticating the connection.

hwndParent

A handle to the parent window which will launch the connection configuration user interface dialog box.

dwFlags

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

pwszMachineName

The name of the target machine being configured. NULL means that the local machine is being configured.

dwSizeOfConfigIn

Specifies the size, in bytes, of pConfigIn. May be set to 0.

pConfigIn

A pointer to a byte buffer that contains configuration elements. The buffer is of size dwSizeOfConfigIn. This parameter can be NULL if dwSizeOfConfigIn is set to 0.

pdwSizeOfConfigOut

Specifies the size, in bytes, of the configuration data returned in ppConfigOut.

ppConfigOut

A pointer to a pointer to a byte buffer that contains updated configuration data from the user. After consuming the data, this memory must be freed by calling EapMethodAuthenticatorFreeMemory.

ppEapError

A pointer to the address of 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 calling EapMethodAuthenticatorFreeErrorMemory.

Return value

None

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header eapmethodauthenticatorapis.h

See also

EAPHost Authenticator Method Functions