ShellUIHelper Object

PROGID

"Shell.UIHelper.1"

CLSID_ShellUIHelper

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

IID_IShellUIHelper

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

The ShellUIHelper object is implemented by the Shell to help script and Microsoft Visual Basic developers to use some of the features available in the Shell. The ShellUIHelper object does not have any properties or events. Methods are provided to add items to the Shell.

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 Methods and Properties

Description

ResetFirstBootMode

Undocumented.

ResetSafeMode

Undocumented.

RefreshOffLineDesktop

Undocumented.

AddFavorite

Displays the default user interface for creating a favorite item. The user interface will be initialized to the specified parameters.

AddChannel

Adds a new channel to the list of channels.

AddDesktopComponent

Adds an item to the Microsoft Active Desktop.

IsSubscribed

Indicates whether or not a URL is subscribed to.

NavigateAndFind

Undocumented.

ImportExportFavorites

Undocumented.

AutoCompleteSaveForm

Undocumented.

AutoScan

Undocumented.

AutoCompleteAttach

Undocumented.

ShowBrowserUI

Undocumented.

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

  LOCAL HRESULT AS LONG
  URL = UCODE$(URL)
  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

  LOCAL HRESULT AS LONG
  URL = UCODE$(URL)
  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 nLeft AS VARIANT _
, BYREF nTop AS VARIANT _
, BYREF nWidth AS VARIANT _
, BYREF nHeight AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  URL = UCODE$(URL) & $NUL
  pbstrType = UCODE$(pbstrType) & $NUL
  CALL DWORD @@pthis[12] USING IShellUIHelper_AddDesktopComponent (pthis, URL, pbstrType, nLeft, nTop, nWidth, nHeight) 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

  LOCAL HRESULT AS LONG
  URL = UCODE$(URL)
  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 vTargetFrame AS VARIANT _
  ) AS LONG

  LOCAL HRESULT AS LONG
  URL = UCODE$(URL) & $NUL
  strQuery = UCODE$(strQuery) & $NUL
  CALL DWORD @@pthis[14] USING IShellUIHelper_NavigateAndFind (pthis, URL, strQuery, vTargetFrame) 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

  LOCAL HRESULT AS LONG
  strImpExpPath = UCODE$(strImpExpPath) & $NUL
  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

  LOCAL HRESULT AS LONG
  strSearch = UCODE$(strSearch) & $NUL
  strFailureUrl = UCODE$(strFailureUrl) & $NUL
  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

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

END FUNCTION