RasEapInvokeConfigUI (Compact 2013)

  • Article

3/26/2014

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 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 has no 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 has no 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 computer; phone-book entries should be portable from computer to computer.
  • pdwSizeOfConnectionDataOut
    [out] Pointer to a DWORD that 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 logon identifier, domain name, and password. The authentication protocol will set the BOOL variable to TRUE to request that RAS display the credentials dialog box, 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 unable 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 RasEapInvokeConfigUI and RasEapFreeMemory may support more than one authentication protocol. The dwEapTypeId parameter specifies for which protocol to invoke the configuration UI.

RAS stores the connection data returned by RasEapInvokeConfigUI in 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.

Requirements

Header

raseapif.h

See Also

Reference

EAP Functions
RasEapFreeMemory
RasEapGetIdentity
RasEapInvokeInteractiveUI