IShellUIHelper::AddDesktopComponent Method

  • Article

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

Syntax

HRESULT AddDesktopComponent(
    BSTR URL,
    BSTR Type,
    VARIANT *Left,
    VARIANT *Top,
    VARIANT *Width,
    VARIANT *Height
);

Parameters

  • URL
    [in] A BSTR that specifies the location of the Web site or image to be added to the Active Desktop.
  • Type
    [in] A BSTR containing one of the following values that specify the type of item to add.
    • image
      Specifies the component is an image.
    • website
      Specifies the component is a Web site.
  • Left
    [in] A pointer to a VARIANT of type VT_I4 that specifies the position of the left edge, in screen coordinates.
  • Top
    [in] A pointer to a VARIANT of type VT_I4 that specifies the position of the top edge, in screen coordinates.
  • Width
    [in] A pointer to a VARIANT of type VT_I4 that specifies the width, in screen units.
  • Height
    [in] A pointer to a VARIANT of type VT_I4 that specifies the height, in screen units.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The user must have Active Desktop installed for this method to work. If Active Desktop is not installed, this method is not invoked.

This method is not supported in HTML Applications (HTAs).