IShellUIHelper Interface

ProgID

$PROGID_ShellUIHelper1 = "Shell.UIHelper.1"

CLSID_ShellUIHelper

{64AB4BB7-111E-11D1-8F79-00C04FC2FBE1}

IID_IShellUIHelper

{729FE2F8-1EA8-11D1-8F85-00C04FC2FBE1}

This interface provides access to features available in the Microsoft Windows Shell API.

To create an instance of the IShellUIHelper object use:

LOCAL CLSID_ShellUIHelper AS GUID

CLSID_ShellUIHelper = GUID$("{64AB4BB7-111E-11D1-8F79-00C04FC2FBE1}")
IID_IShellUIHelper = GUID$("{729FE2F8-1EA8-11D1-8F85-00C04FC2FBE1}")
hr = CoCreateInstance (CLSID_ShellUIHelper, BYVAL %NULL, %CLSCTX_INPROC_SERVER, IID_IShellUIHelper, pIShellUIHelper)
 

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IDispatch Methods

Description

GetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

GetTypeInfo

Gets the type information for an object.

GetIDsOfNames

Maps a single member and an optional set of argument names to a corresponding set of integer DISPIDs.

Invoke

Provides access to properties and methods exposed by an object.

IShellUIHelper Members

Description

ResetFirstBootMode

Undocumented.

ResetSafeMode

Undocumented.

RefreshOfflineDesktop

Undocumented.

AddFavorite

Prompts the user with a dialog box to add the specified URL to the Favorites list.

AddChannel

Presents a dialog box that enables the user to either add the channel specified, or change the channel URL if it is already installed.

AddDesktopComponent

Adds a Web site or image to the Microsoft Active Desktop.

IsSubscribed

Retrieves a value indicating whether the client subscribes to the given channel.

NavigateAndFind

Navigates to the specified URL and selects the specified text.

ImportExportFavorites

Handles the importing and exporting of Microsoft Internet Explorer favorites.

AutoCompleteSaveForm

Saves the specified form in the AutoComplete data store.

AutoScan

Attempts to connect to a Web server by passing the specified query through completion templates.

AutoCompleteAttach

Undocumented.

ShowBrowserUI

Opens the specified browser dialog box.

ResetFirstBootMode

FUNCTION IShellUIHelper_ResetFirstBootMode ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IShellUIHelper_ResetFirstBootMode (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

ResetSafeMode

FUNCTION IShellUIHelper_ResetSafeMode ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IShellUIHelper_ResetSafeMode (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

RefreshOffLineDesktop

FUNCTION IShellUIHelper_RefreshOfflineDesktop ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IShellUIHelper_RefreshOfflineDesktop (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

AddFavorite

FUNCTION IShellUIHelper_AddFavorite ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL URL AS STRING _
, BYREF Title AS VARIANT _
  ) AS LONG

  URL = UCODE$(URL)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IShellUIHelper_AddFavorite (pthis, URL, Title) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

AddChannel

FUNCTION IShellUIHelper_AddChannel ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL URL AS STRING _
  ) AS LONG

  URL = UCODE$(URL)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IShellUIHelper_AddChannel (pthis, URL) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

AddDesktopComponent

FUNCTION IShellUIHelper_AddDesktopComponent ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL URL AS STRING _
, BYVAL pbstrType AS STRING _
, BYREF prmLeft AS VARIANT _
, BYREF Top AS VARIANT _
, BYREF prmWidth AS VARIANT _
, BYREF Height AS VARIANT _
  ) AS LONG

  URL = UCODE$(URL)
  pbstrType = UCODE$(pbstrType)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IShellUIHelper_AddDesktopComponent (pthis, URL, pbstrType, prmLeft, Top, prmWidth, Height) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsSubscribed

FUNCTION IShellUIHelper_IsSubscribed ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL URL AS STRING _
, BYREF pBool AS INTEGER _
  ) AS LONG

  URL = UCODE$(URL)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IShellUIHelper_IsSubscribed (pthis, URL, pBool) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

NavigateAndFind

FUNCTION IShellUIHelper_NavigateAndFind ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL URL AS STRING _
, BYVAL strQuery AS STRING _
, BYREF varTargetFrame AS VARIANT _
  ) AS LONG

  URL = UCODE$(URL)
  strQuery = UCODE$(strQuery)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IShellUIHelper_NavigateAndFind (pthis, URL, strQuery, varTargetFrame) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ImportExportFavorites

FUNCTION IShellUIHelper_ImportExportFavorites ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fImport AS INTEGER _
, BYVAL strImpExpPath AS STRING _
  ) AS LONG

  strImpExpPath = UCODE$(strImpExpPath)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[15] USING IShellUIHelper_ImportExportFavorites (pthis, fImport, strImpExpPath) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

AutoCompleteSaveForm

FUNCTION IShellUIHelper_AutoCompleteSaveForm ( _
  BYVAL pthis AS DWORD PTR _
, BYREF Form AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING IShellUIHelper_AutoCompleteSaveForm (pthis, Form) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

AutoScan

FUNCTION IShellUIHelper_AutoScan ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strSearch AS STRING _
, BYVAL strFailureUrl AS STRING _
, BYREF pvarTargetFrame AS VARIANT _
  ) AS LONG

  strSearch = UCODE$(strSearch)
  strFailureUrl = UCODE$(strFailureUrl)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[17] USING IShellUIHelper_AutoScan (pthis, strSearch, strFailureUrl, pvarTargetFrame) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

AutoCompleteAttach

FUNCTION IShellUIHelper_AutoCompleteAttach ( _
  BYVAL pthis AS DWORD PTR _
, BYREF Reserved AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[18] USING IShellUIHelper_AutoCompleteAttach (pthis, Reserved) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION

ShowBrowserUI

FUNCTION IShellUIHelper_ShowBrowserUI ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL bstrName AS STRING _
, BYREF pvarIn AS VARIANT _
, BYREF pvarOut AS VARIANT _
  ) AS LONG

  bstrName = UCODE$(bstrName)
  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[19] USING Proto_IShellUIHelper_ShowBrowserUI (pthis, bstrName, pvarIn, pvarOut) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION