msSiteModeSetIconOverlay method
Adds an icon overlay to the pinned site taskbar button.
 |
Syntax
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 String that provides an accessible description of the icon overlay.
Return value
Type: HRESULT
This method can return one of these values.
| Return code | Description |
|---|---|
|
The current page is not in the same domain as the start URL of pinned site. |
|
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 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.
See also