Admin Production ni-theme
Current Publication

RemoveSysTrayIcon

LabWindows/CVI

RemoveSysTrayIcon

int RemoveSysTrayIcon (int iconHandle);

Purpose

This function removes the specied icon from the System Tray and frees all resources. The function destroys any menus associated with the icon.

(Linux) This function is not supported.

Parameters

Input
Name Type Description
iconHandle int The handle of the System Tray icon to remove. This handle will have been returned from InstallSysTrayIcon.

Return Value

Name Type Description
status int The status code that the function returns.

0 indicates success.

A negative value indicates an error.

This function may return a Programmer's Toolbox or UI Library error code. Call GetGeneralErrorString to obtain a text description of the error.

Additional Information

Library: Programmer's Toolbox

Include file: toolbox\toolbox.h

LabWindows/CVI compatibility: LabWindows/CVI 5.5 and later

Example

Refer to toolbox\trayicon.cws for an example of using the RemoveSysTrayIcon function.