AddSysTrayIcon

AddSysTrayIcon()

Syntax

Result = AddSysTrayIcon(#SysTrayIcon, WindowID, ImageID)

Description

Adds an icon in the SysTray area.

When an event occurs on any of the SysTray icons the #PB_Event_SysTray event is sent. EventGadget() can be used to know which SysTrayIcon has been used. EventType() functions is also updated by this function.

Parameters

#SysTrayIcon A number to identify the new systray icon. #PB_Any can be used to auto-generate this number.

WindowID The window on which will handle the systray events. WindowID() can be used to get this value.

ImageID The image to use for the systray icon. Only icon image type (.ico) are supported on Windows, for Linux and OS X it is advised to use a PNG image (in order to have a transparency layer). ImageID() may be used to get this ID easily.

Return value

Nonzero if the systray icon has been successfully added, zero otherwise.

Remarks

All SysTray icons are automatically removed when the program ends.

See Also

RemoveSysTrayIcon(), ChangeSysTrayIcon()

Supported OS

All

SysTray Index - ChangeSysTrayIcon() ->

#SysTrayIcon	A number to identify the new systray icon. #PB_Any can be used to auto-generate this number.
WindowID	The window on which will handle the systray events. WindowID() can be used to get this value.
ImageID	The image to use for the systray icon. Only icon image type (.ico) are supported on Windows, for Linux and OS X it is advised to use a PNG image (in order to have a transparency layer). ImageID() may be used to get this ID easily.