Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function is called by RAS to obtain configuration information from the user.

Syntax 

DWORD RasEapInvokeConfigUI(
  DWORD 
dwEapTypeId, 
  HINSTANCE 
hInstance, 
  HWND 
hwndParent, 
  DWORD 
dwFlags, 
  BYTE* 
pConnectionDataIn, 
  DWORD 
dwSizeOfConnectionDataIn, 
  BYTE** 
ppConnectionDataOut, 
  DWORD* 
pdwSizeOfConnectionDataOut 
);

Parameters

dwEapTypeId

[in] Specifies the authentication protocol for which to invoke the configuration user interface (UI).

hInstance

Handle to the dynamic-link library (DLL) module.

hwndParent

[in] Handle to the parent window for the UI dialog.

dwFlags

[in] Specifies whether the computer that is dialing in is a router or a RAS client. If the computer is a router, this parameter should be set to:

RAS_EAP_FLAG_ROUTER

Otherwise, this parameter should be zero.

pConnectionDataIn

[in] Pointer to the connection data currently stored in the phone-book entry. If the phone-book entry does not contain any data, this parameter is NULL.

dwSizeOfConnectionDataIn

[in] Specifies the size of the connection data currently stored in the phone-book entry. If the phone-book entry for this connection does not contain any data, this parameter will be zero.

ppConnectionDataOut

[out] Pointer to a pointer that, on successful return, points to the new connection data to store in the phone-book entry. None of this data should be specific to the current development workstation; phone-book entries should be portable from workstation to workstation.

pdwSizeOfConnectionDataOut

[out] Pointer to a DWORDthat receives the size of the new connection data to store in the phone-book entry.

fInvokeStandardCredentialsDialog

Pointer to a BOOL variable that specifies whether RAS should display the standard credentials dialog. The credentials dialog requests the user's login identifier, domain name, and password. The authentication protocol will set the BOOL variable to TRUE to request that RAS display the credentials dialog, FALSE otherwise.

szIdentity

Pointer to a buffer that contains an identifier for the user. The length of this buffer is UNLEN+DNLEN+2.

Return Value

If the function call succeeds, the return value is NO_ERROR.

If the function was not able to allocate memory for the configuration data, the return value should be ERROR_NOT_ENOUGH_MEMORY.

If the function call fails in some other way, it returns an appropriate error code from Winerror.h, Raserror.h, or Mprerror.h.

Remarks

The DLL that implements RasEapInvokeConfigUIand RasEapFreeMemorymay support more than one authentication protocol. The dwEapTypeIdparameter specifies for which protocol to invoke the configuration UI.

RAS stores the connection data returned by RasEapInvokeConfigUIin the phone-book entry for the connection on the client computer.

Note:
This function is called by the EAP module, not by the application. Therefore, no link library is exposed. For more information, see EAP Implementation Details.

Requirements

Header raseapif.h
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later
Note This function is called by the EAP module, not by the application. Therefore, no link library is exposed. For more information see EAP Implementation Details.

See Also