Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

Shell_NotifyIcon (shell32)
 
.
Summary

Retrieves the Notifyicon bounding rectangle.

Summary
The Shell_NotifyIcon API

C# Signature:

    [DllImport("shell32.dll", SetLastError = true)]
    static extern int Shell_NotifyIconGetRect([In]ref NOTIFYICONIDENTIFIER identifier, [Out]out RECT iconLocation);

[DllImport("shell32.dll")]
static extern bool Shell_NotifyIcon(uint dwMessage,
   [In] ref NOTIFYICONDATA pnid);

VB.NET Signature

<DllImport("shell32.dll")> _
Shared Function Shell_NotifyIcon(dwMessage as UInteger, ByRef pnid as NOTIFYICONDATA) as Boolean
End Function

User-Defined Types:

NOTIFYICONIDENTIFIER

RECT

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

Minimum supported client: Windows 7 [desktop apps only]

Minimum supported server: Windows Server 2008 R2 [desktop apps only]

Tips & Tricks:

Please add some!

Sample Code:

Here's the data structure for the NotifyIconData block, contributed by staff at http://www.softswift.com

    [StructLayout(LayoutKind.Sequential)]
    public struct RECT
    public struct NotifyIconData
    {
        public Int32 left;
        public Int32 top;
        public Int32 right;
        public Int32 bottom;
        public System.Int32 cbSize; // DWORD
        public System.IntPtr hWnd; // HWND
        public System.Int32 uID; // UINT
        public NotifyFlags uFlags; // UINT
        public System.Int32 uCallbackMessage; // UINT
        public System.IntPtr hIcon; // HICON
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst=128)]
        public System.String szTip; // char[128]
        public System.Int32 dwState; // DWORD
        public System.Int32 dwStateMask; // DWORD
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst=256)]
        public System.String szInfo; // char[256]
        public System.Int32 uTimeoutOrVersion; // UINT
        [MarshalAs(UnmanagedType.ByValTStr, SizeConst=64)]
        public System.String szInfoTitle; // char[64]
        public System.Int32 dwInfoFlags; // DWORD
        //GUID guidItem; > IE 6
    }

    [StructLayout(LayoutKind.Sequential)]
    public struct NOTIFYICONIDENTIFIER
    {
        public uint cbSize;
        public IntPtr hWnd;
        public uint uID;
        public Guid guidItem;
    }

    [DllImport("shell32.dll", SetLastError = true)]
    private static extern int Shell_NotifyIconGetRect([In]ref NOTIFYICONIDENTIFIER identifier, [Out]out RECT iconLocation);

    public static RECT GetNotifyIconRect(IntPtr windowHandle, uint taskbarIconId)
    {
        var rect = new RECT();
        var notifyIcon = new NOTIFYICONIDENTIFIER();
        notifyIcon.cbSize = (uint)Marshal.SizeOf(notifyIcon.GetType());
        notifyIcon.hWnd = windowHandle;
        notifyIcon.uID = taskbarIconId;
        var hresult = Shell_NotifyIconGetRect(ref notifyIcon, out rect);
        if (hresult == 0x80004005)
        {
            // E_FAIL, will happen if the icon is not there.
            throw new Win32Exception(hresult, "Failed to get icon position.");
        }

        if (hresult != 0)
        {
            throw new Win32Exception(hresult);
        }

And then we noticed that the data structure is already provided elsewhere on this site but without a reference so here's the reference http://www.pinvoke.net/default.aspx/Structures.NOTIFYICONDATA

        return rect;
    }

Notes:

None.

Documentation

Tips & Tricks:

Please add some!

Sample Code:

Please add some!

Alternative Managed API:

System.Windows.Forms.NotifyIcon

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions