IAutoComplete::Init method (shldisp.h)

Initializes the autocomplete object.


  [in]           HWND     hwndEdit,
  [in]           IUnknown *punkACL,
  [in, optional] LPCWSTR  pwszRegKeyPath,
  [in, optional] LPCWSTR  pwszQuickComplete


[in] hwndEdit

Type: HWND

A handle to the window for the system edit control for which autocompletion will be enabled.

[in] punkACL

Type: IUnknown*

A pointer to the IUnknown interface of the string list object that generates candidates for the completed string. The object must expose an IEnumString interface.

[in, optional] pwszRegKeyPath


A pointer to an optional, null-terminated Unicode string that gives the registry path, including the value name, where the format string is stored as a REG_SZ value. The autocomplete object first looks for the path under HKEY_CURRENT_USER. If it fails, it tries HKEY_LOCAL_MACHINE. For a discussion of the format string, see the definition of pwszQuickComplete.

[in, optional] pwszQuickComplete


A pointer to an optional null-terminated Unicode string that specifies the format to be used if the user enters text and presses CTRL+ENTER. Set this parameter to NULL to disable quick completion. Otherwise, the autocomplete object treats pwszQuickComplete as a StringCchPrintf format string and the text in the edit box as its associated argument, to produce a new string. For example, set pwszQuickComplete to "http://www.%s.com/". When a user enters "MyURL" into the edit box and presses CTRL+ENTER, the text in the edit box is updated to "http://www.MyURL.com/".

Return value


If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.


Requirement Value
Minimum supported client Windows 2000 Professional, Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shldisp.h
DLL Shell32.dll (version 5.0 or later)

See also