| Function group | Execute on client | Platform(s) |
|---|---|---|
| ONOTIFY | NO | All |
ONOTIFY.$setbadgeicon(vIconId[,&cErrorText,iBadgeColor])
Note this is available on Windows only. Sets the badge on the application icon to be the specified icon vIconId. Returns Boolean true for success, or false (and sets cErrorText) if an error occurs.
The parameters are as follows:
| Parameter | Description |
|---|---|
| vIconId | The icon id of the icon to display as the badge. The size component is ignored, as badges are always 16x16. |
| cErrorText | A character variable that receives text describing an error, if $setbadgeicon() fails |
| iBadgeColor | The color to be applied to the themed SVG; only applies if the icon is a themed SVG. Default is kColorHilight. |