msSiteModeSetIconOverlay method

  • Article

Adds an icon overlay to the pinned site taskbar button.

This method is not supported for Windows apps using JavaScript.

 

Syntax

HRESULT retVal = object.msSiteModeSetIconOverlay(IconUrl, pvarDescription);

Parameters

  • IconUrl [in]
    Type: BSTR

    Absolute URL of an icon resource file.

  • pvarDescription [in, optional]
    Type: VARIANT

    A VARIANT of type VT_BSTR that provides an accessible description of the icon overlay.

Return value

Type: HRESULT

This method can return one of these values.

Return code Description
S_OK

The operation completed successfully.
E_ACCESSDENIED

The current page is not in the same domain as the start URL of pinned site.
E_NOTIMPL

This method is not supported on Windows CE.

 

Standards information

There are no standards that apply here.

Remarks

This method creates an icon overlay that you can use to communicate alerts, notifications, and application status to users. Call IShellUIHelper4::msSiteModeClearIconOverlay to remove the overlay. The pvarDescription parameter provides an accessible description (Microsoft UI Automation "HelpText") of the information conveyed by the icon overlay.

The icon resource file must contain a 16x16 icon at 96 dots per inch (dpi). If an icon overlay is already applied, the existing overlay is replaced.

Note  To view the icon overlay, the taskbar buttons must be in their default large icon mode. Small taskbar icons do not support icon overlays.

 

See also

IShellUIHelper4::msSiteModeClearIconOverlay