sysTraySet()

Sets an attribute for the system tray icon to a specified value.

Synopsis

int sysTraySet(string attribute, anytype value)

Parameter

Parameter Description
attribute
  • "visible" (bool) – Show or hide the system tray icon.
  • "toolTip" (string) – Tooltip text shown on hover.
  • "icon" (string) – Relative path to the icon file
Note:

As usual, a file extension is not needed and .png, .xpm, etc. are searched. The icon is also searched in the activeIconTheme subfolder.

value The value to assign to the given attribute (data type depends on the attribute).

Return Value

Returns 0 on success. Returns -1 if an unknown attribute is provided.

Details

-

sysTraySet

main(mapping event)
{
  int retVal;
  
  retVal = sysTraySet("visible",true); //Set the icon visible
  retVal = sysTraySet("toolTip","bit.png"); //Set the tooltip
  retVal = sysTraySet("icon","themes/modern/dptree/bit.png"); //Set the icon
  
  printResult((string)retVal);
}

Availability

CTRL

Assignment

System Tray