Export (0) Print
Expand All

IShellUIHelper4::msSiteModeSetIconOverlay Method

New for Windows Internet Explorer 9

Adds an icon overlay to the pinned site taskbar button.

Syntax


HRESULT msSiteModeSetIconOverlay(
    BSTR IconUrl,
    VARIANT *pvarDescription
);

Parameters

IconUrl
[in] Absolute URL of an icon resource file.
pvarDescription
[in] A VARIANT of type VT_BSTR that provides an accessible description of the icon overlay.

Return Value

Returns one of the following values.

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.

Remarks

This method creates an icon overlay that you can use to communicate alerts, notifications, and application status to users. Call 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

Community Additions

ADD
Show:
© 2014 Microsoft