Win32 API 日本語リファレンス
ホームUI.Shell › NOTIFYICONDATAW

NOTIFYICONDATAW

構造体
サイズx64: 968 バイト / x86: 956 バイトパッキング1

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
cbSizeDWORD4+0+0この構造体のサイズ (バイト単位)。
hWndHWND8/4+4+4通知領域のアイコンに関連付けられた通知を受け取るウィンドウへのハンドル。
uIDDWORD4+12+8タスクバーアイコンのアプリケーション定義の識別子。シェルは、Shell_NotifyIcon が呼び出されたときに、どのアイコンを操作するかを識別するために (hWnduID の組み合わせ) または guidItem のいずれかを使用します。それぞれに異なる uID を割り当てることで、1 つの hWnd に複数のアイコンを関連付けることができます。guidItem が指定されている場合、uID は無視されます。
uFlagsNOTIFY_ICON_DATA_FLAGS4+16+12

構造体の他のメンバーのうちどれが有効なデータを保持しているかを示すフラグ、またはツールチップの表示方法に関する追加情報を与えるフラグです。このメンバーには次の値の組み合わせを指定できます:

NIF_MESSAGE (0x00000001)

0x00000001。uCallbackMessage メンバーが有効です。

NIF_ICON (0x00000002)

0x00000002。hIcon メンバーが有効です。

NIF_TIP (0x00000004)

0x00000004。szTip メンバーが有効です。

NIF_STATE (0x00000008)

0x00000008。dwState メンバーと dwStateMask メンバーが有効です。

NIF_INFO (0x00000010)

0x00000010。バルーン通知を表示します。szInfoszInfoTitledwInfoFlagsuTimeout の各メンバーが有効です。uTimeout が有効なのは Windows 2000 と Windows XP のみである点に注意してください。

  • バルーン通知を表示するには、NIF_INFO を指定し、szInfo にテキストを設定します。
  • バルーン通知を削除するには、NIF_INFO を指定し、szInfo に空の文字列を渡します。
  • 通知を表示せずに通知領域のアイコンだけを追加するには、NIF_INFO フラグを設定しないでください。

NIF_GUID (0x00000020)

0x00000020。

  • Windows 7 以降: guidItem が有効です。
  • Windows Vista 以前: 予約済みです。

NIF_REALTIME (0x00000040)

0x00000040。Windows Vista 以降。バルーン通知をすぐに表示できない場合は破棄します。後から表示したのでは無意味になる、あるいは誤解を招くリアルタイム情報を表す通知には、このフラグを使用します。たとえば「電話が鳴っています。」といったメッセージです。NIF_REALTIMENIF_INFO フラグと組み合わせた場合にのみ意味を持ちます。

NIF_SHOWTIP (0x00000080)

0x00000080。Windows Vista 以降。標準のツールチップを使用します。通常、uVersionNOTIFYICON_VERSION_4 が設定されている場合、標準のツールチップは抑制され、アプリケーションが描画するポップアップ UI に置き換えることができます。NOTIFYICON_VERSION_4 でも標準のツールチップを表示したい場合は、NIF_SHOWTIP を指定して標準のツールチップを引き続き表示するよう指示できます。

uCallbackMessageDWORD4+20+16

アプリケーション定義のメッセージ識別子。システムはこの識別子を使用して、hWnd で指定されたウィンドウに通知メッセージを送信します。これらの通知メッセージは、アイコンの外接矩形内でマウスイベントやホバーが発生したとき、キーボードでアイコンが選択またはアクティブ化されたとき、あるいはバルーン通知内でそれらの操作が行われたときに送信されます。

uVersion メンバーが 0 または NOTIFYICON_VERSION の場合、メッセージの wParam パラメーターには、イベントが発生したタスクバーアイコンの識別子が格納されます。この識別子は 32 ビット長にできます。lParam パラメーターには、そのイベントに関連付けられたマウスまたはキーボードのメッセージが格納されます。たとえば、ポインターがタスクバーアイコンの上を移動すると、lParam には WM_MOUSEMOVE が設定されます。

uVersion メンバーが NOTIFYICON_VERSION_4 の場合も、アプリケーションは uCallbackMessage メンバーを通じてアプリケーション定義のメッセージという形で通知イベントを受け取り続けますが、そのメッセージの lParam パラメーターと wParam パラメーターの解釈が次のように変わります:

  • LOWORD(lParam) には、NIN_BALLOONSHOWNIN_POPUPOPENWM_CONTEXTMENU などの通知イベントが格納されます。
  • HIWORD(lParam) にはアイコン ID が格納されます。アイコン ID は 16 ビット長に制限されます。
  • GET_X_LPARAM(wParam) は、通知イベント NIN_POPUPOPENNIN_SELECT、NIN_KEYSELECT、および WM_MOUSEFIRST から WM_MOUSELAST までのすべてのマウスメッセージについて、X アンカー座標を返します。これらのメッセージがキーボードによって生成された場合、wParam には対象アイコンの左上隅が設定されます。それ以外のすべてのメッセージでは、wParam は未定義です。
  • GET_Y_LPARAM(wParam) は、X アンカーについて定義したものと同じ通知イベントおよびメッセージについて、Y アンカー座標を返します。
hIconHICON8/4+24+20

追加、変更、または削除するアイコンへのハンドル。Windows XP 以降では最大 32 BPP のアイコンをサポートします。

16x16 ピクセルのアイコンしか提供しない場合、高い dpi 値に設定されたシステムではより大きなサイズに拡大され、見栄えが悪くなることがあります。リソースファイルには 16x16 ピクセルのアイコンと 32x32 のアイコンの両方を用意することを推奨します。LoadIconMetric を使用すると、正しいアイコンが読み込まれ、適切に拡大縮小されます。コード例については「解説」を参照してください。

szTipWCHAR256+32+24

標準のツールチップに表示するテキストを指定する null 終端文字列。終端の null 文字を含めて最大 64 文字です。

Windows 2000 以降では、szTip は終端の null 文字を含めて最大 128 文字を指定できます。

dwStateNOTIFY_ICON_STATE4+288+280

Windows 2000 以降。アイコンの状態。次の値のいずれか、または両方です:

NIS_HIDDEN (0x00000001)

0x00000001。アイコンは非表示です。

NIS_SHAREDICON (0x00000002)

0x00000002。アイコンリソースは複数のアイコンで共有されます。

dwStateMaskNOTIFY_ICON_STATE4+292+284Windows 2000 以降dwState メンバーのどのビットを取得または変更するかを指定する値。指定できる値は dwState と同じです。たとえば、このメンバーに NIS_HIDDEN を設定すると、項目の非表示状態だけが変更され、アイコン共有ビットはその値にかかわらず無視されます。
szInfoWCHAR512+296+288Windows 2000 以降。バルーン通知に表示するテキストを指定する null 終端文字列。終端の null 文字を含めて最大 256 文字ですが、ローカライズに対応するため英語では 200 文字以内に抑えるべきです。バルーン通知を UI から削除するには、アイコンを削除する (NIM_DELETE を使用する) か、uFlagsNIF_INFO フラグを設定して szInfo を空の文字列にします。
Anonymous_Anonymous_e__Union4+808+800uTimeout と uVersion を共用する無名共用体。
szInfoTitleWCHAR128+812+804Windows 2000 以降。バルーン通知のタイトルを指定する null 終端文字列。このタイトルはテキストのすぐ上に大きめのフォントで表示されます。終端の null 文字を含めて最大 64 文字ですが、ローカライズに対応するため英語では 48 文字以内に抑えるべきです。
dwInfoFlagsNOTIFY_ICON_INFOTIP_FLAGS4+940+932

Windows 2000 以降。バルーン通知の動作と外観を変更するために設定できるフラグ。アイコンはタイトルの左側に配置されます。szInfoTitle メンバーの長さが 0 の場合、アイコンは表示されません。

NIIF_NONE (0x00000000)

0x00000000。アイコンなし。

NIIF_INFO (0x00000001)

0x00000001。情報アイコン。

NIIF_WARNING (0x00000002)

0x00000002。警告アイコン。

NIIF_ERROR (0x00000003)

0x00000003。エラーアイコン。

NIIF_USER (0x00000004)

0x00000004。Windows XP SP2 以降

  • Windows XP: hIcon で指定されたアイコンを通知バルーンのタイトルアイコンとして使用します。
  • Windows Vista 以降: hBalloonIcon で指定されたアイコンを通知バルーンのタイトルアイコンとして使用します。

NIIF_NOSOUND (0x00000010)

0x00000010。Windows XP 以降。関連付けられたサウンドを再生しません。通知にのみ適用されます。

NIIF_LARGE_ICON (0x00000020)

0x00000020。Windows Vista 以降。通知アイコンとしてアイコンの大きいバージョンを使用します。これは SM_CXICON x SM_CYICON の寸法のアイコンに対応します。このフラグが設定されていない場合は、SM_CXSMICON x SM_CYSMICON の寸法のアイコンが使用されます。

  • このフラグはすべての ストックアイコン で使用できます。
  • 従来のカスタムアイコン (NIIF_USERhIcon の組み合わせ) を使用するアプリケーションは、トレイアイコン (hIcon) に新しい SM_CXICON x SM_CYICON バージョンを用意する必要があります。これらのアイコンは、システムトレイまたはシステムコントロールエリア (SCA) に表示される際に縮小されます。
  • 新しいカスタムアイコン (NIIF_USERhBalloonIcon の組み合わせ) は、指定するアイコン (hBalloonIcon) に SM_CXICON x SM_CYICON バージョンを用意する必要があります。

NIIF_RESPECT_QUIET_TIME (0x00000080)

0x00000080。Windows 7 以降。現在のユーザーが「クワイエットタイム」中の場合は、バルーン通知を表示しません。クワイエットタイムとは、新しいユーザーが自分のアカウントに初めてログオンしてからの最初の 1 時間のことです。この間、ほとんどの通知は送信も表示もすべきではありません。これにより、ユーザーは煩わされることなく新しいコンピューターシステムに慣れることができます。クワイエットタイムは、オペレーティングシステムのアップグレードやクリーンインストールの後にも各ユーザーに対して発生します。クワイエットタイム中にこのフラグを指定して送信された通知はキューに入れられず、表示されないまま破棄されます。その通知が後の時点でも有効であれば、アプリケーションは改めて送信できます。

アプリケーションはいつクワイエットタイムに遭遇するかを予測できないため、クワイエットタイムを尊重するアプリケーションでは、対象となるすべての通知に対して常にこのフラグを設定することを推奨します。

クワイエットタイム中であっても、USB デバイスを接続したときやドキュメントを印刷したときなど、ユーザーの操作に対するフィードバックとしてユーザーが期待する通知は送信すべきです。

現在のユーザーがクワイエットタイム中でない場合、このフラグは効果を持ちません。

NIIF_ICON_MASK (0x0000000F)

0x0000000F。Windows XP 以降。予約済みです。

guidItemGUID16+944+936

Windows XP 以降

  • Windows 7 以降: アイコンを識別する登録済みの GUID。この値は uID より優先され、アイコンを識別する推奨方法です。uFlags メンバーに NIF_GUID フラグを設定しなければなりません。
  • Windows XP および Windows Vista: 予約済みです。0 を設定しなければなりません。
アプリケーションを Windows Vista と Windows 7 の両方で動作させる場合は、Windows のバージョンを確認し、Windows 7 以降の場合にのみ 0 以外の guidItem を指定することが不可欠です。

Shell_NotifyIcon の呼び出しで通知アイコンを GUID によって識別した場合は、同じアイコンを扱う以降の Shell_NotifyIcon の呼び出しでも、同じ GUID を使用してアイコンを識別しなければなりません。

このメンバーで使用する GUID を生成するには、Guidgen.exe などの GUID 生成ツールを使用します。

hBalloonIconHICON8/4+960+952

Windows Vista 以降。通知領域のアイコンとは独立して使用される、アプリケーションが提供するカスタム通知アイコンのハンドル。このメンバーが NULL 以外で、かつ dwInfoFlags メンバーに NIIF_USER フラグが設定されている場合、このアイコンが通知アイコンとして使用されます。このメンバーが NULL の場合は、従来の動作が行われます。

- dwInfoFlags.NIIF_ERROR (0x00000003)

0x00000003。エラーアイコン。

- dwInfoFlags.NIIF_ICON_MASK (0x0000000F)

0x0000000F。Windows XP 以降。予約済みです。

- dwInfoFlags.NIIF_INFO (0x00000001)

0x00000001。情報アイコン。

- dwInfoFlags.NIIF_LARGE_ICON (0x00000020)

0x00000020。Windows Vista 以降。通知アイコンとしてアイコンの大きいバージョンを使用します。これは SM_CXICON x SM_CYICON の寸法のアイコンに対応します。このフラグが設定されていない場合は、SM_CXSMICON x SM_CYSMICON の寸法のアイコンが使用されます。

  • このフラグはすべての ストックアイコン で使用できます。
  • 従来のカスタムアイコン (NIIF_USERhIcon の組み合わせ) を使用するアプリケーションは、トレイアイコン (hIcon) に新しい SM_CXICON x SM_CYICON バージョンを用意する必要があります。これらのアイコンは、システムトレイまたはシステムコントロールエリア (SCA) に表示される際に縮小されます。
  • 新しいカスタムアイコン (NIIF_USERhBalloonIcon の組み合わせ) は、指定するアイコン (hBalloonIcon) に SM_CXICON x SM_CYICON バージョンを用意する必要があります。
- dwInfoFlags.NIIF_NONE (0x00000000)

0x00000000。アイコンなし。

- dwInfoFlags.NIIF_NOSOUND (0x00000010)

0x00000010。Windows XP 以降。関連付けられたサウンドを再生しません。通知にのみ適用されます。

- dwInfoFlags.NIIF_RESPECT_QUIET_TIME (0x00000080)

0x00000080。Windows 7 以降。現在のユーザーが「クワイエットタイム」中の場合は、バルーン通知を表示しません。クワイエットタイムとは、新しいユーザーが自分のアカウントに初めてログオンしてからの最初の 1 時間のことです。この間、ほとんどの通知は送信も表示もすべきではありません。これにより、ユーザーは煩わされることなく新しいコンピューターシステムに慣れることができます。クワイエットタイムは、オペレーティングシステムのアップグレードやクリーンインストールの後にも各ユーザーに対して発生します。クワイエットタイム中にこのフラグを指定して送信された通知はキューに入れられず、表示されないまま破棄されます。その通知が後の時点でも有効であれば、アプリケーションは改めて送信できます。

アプリケーションはいつクワイエットタイムに遭遇するかを予測できないため、クワイエットタイムを尊重するアプリケーションでは、対象となるすべての通知に対して常にこのフラグを設定することを推奨します。

クワイエットタイム中であっても、USB デバイスを接続したときやドキュメントを印刷したときなど、ユーザーの操作に対するフィードバックとしてユーザーが期待する通知は送信すべきです。

現在のユーザーがクワイエットタイム中でない場合、このフラグは効果を持ちません。

- dwInfoFlags.NIIF_USER (0x00000004)

0x00000004。Windows XP SP2 以降

  • Windows XP: hIcon で指定されたアイコンを通知バルーンのタイトルアイコンとして使用します。
  • Windows Vista 以降: hBalloonIcon で指定されたアイコンを通知バルーンのタイトルアイコンとして使用します。
- dwInfoFlags.NIIF_WARNING (0x00000002)

0x00000002。警告アイコン。

- dwState.NIS_HIDDEN (0x00000001)

0x00000001。アイコンは非表示です。

- dwState.NIS_SHAREDICON (0x00000002)

0x00000002。アイコンリソースは複数のアイコン間で共有されます。

- uFlags.NIF_GUID (0x00000020)

0x00000020。

  • Windows 7 以降: guidItem が有効です。
  • Windows Vista 以前: 予約済みです。
- uFlags.NIF_ICON (0x00000002)

0x00000002。hIcon メンバーが有効です。

- uFlags.NIF_INFO (0x00000010)

0x00000010。バルーン通知を表示します。szInfoszInfoTitledwInfoFlagsuTimeout の各メンバーが有効です。uTimeout が有効なのは Windows 2000 と Windows XP のみである点に注意してください。

  • バルーン通知を表示するには、NIF_INFO を指定し、szInfo にテキストを設定します。
  • バルーン通知を削除するには、NIF_INFO を指定し、szInfo に空の文字列を渡します。
  • 通知を表示せずに通知領域のアイコンだけを追加するには、NIF_INFO フラグを設定しないでください。
- uFlags.NIF_MESSAGE (0x00000001)

0x00000001。uCallbackMessage メンバーが有効です。

- uFlags.NIF_REALTIME (0x00000040)

0x00000040。Windows Vista 以降。バルーン通知をすぐに表示できない場合は破棄します。後から表示したのでは無意味になる、あるいは誤解を招くリアルタイム情報を表す通知には、このフラグを使用します。たとえば「電話が鳴っています。」といったメッセージです。NIF_REALTIMENIF_INFO フラグと組み合わせた場合にのみ意味を持ちます。

- uFlags.NIF_SHOWTIP (0x00000080)

0x00000080。Windows Vista 以降。標準のツールチップを使用します。通常、uVersionNOTIFYICON_VERSION_4 が設定されている場合、標準のツールチップは抑制され、アプリケーションが描画するポップアップ UI に置き換えることができます。NOTIFYICON_VERSION_4 でも標準のツールチップを表示したい場合は、NIF_SHOWTIP を指定して標準のツールチップを引き続き表示するよう指示できます。

- uFlags.NIF_STATE (0x00000008)

0x00000008。dwState メンバーと dwStateMask メンバーが有効です。

- uFlags.NIF_TIP (0x00000004)

0x00000004。szTip メンバーが有効です。

- uVersion.0

Windows 2000 より前の Windows バージョン向けに設計されたアプリケーションでは、この値を使用します。

- uVersion.NOTIFYICON_VERSION

Windows 2000 の動作を使用します。Windows 2000 以降向けに設計されたアプリケーションでは、この値を使用します。

- uVersion.NOTIFYICON_VERSION_4

現在の動作を使用します。Windows Vista 以降向けに設計されたアプリケーションでは、この値を使用します。

共用体: _Anonymous_e__Union x64 4B / x86 4B

フィールドサイズx64x86説明
uTimeoutDWORD4+0+0

Windows 2000 以降

Note このメンバーは Windows Vista 以降では非推奨です。通知の表示時間は現在、システムのユーザー補助設定に基づいて決まります。
uVersion との共用体です。通知のタイムアウト値 (ミリ秒単位)。システムは最小および最大のタイムアウト値を強制します。uTimeout に指定した値が大きすぎる場合は最大値に設定され、小さすぎる場合は最小値が使用されます。システムの最小および最大のタイムアウト値は、現在それぞれ 10 秒と 30 秒に設定されています。uTimeout の詳細については「解説」を参照してください。
uVersionDWORD4+0+0Windows 2000 以降uTimeout (Windows Vista 以降では非推奨) との共用体です。シェルの通知アイコンインターフェイスのどのバージョンを使用するかを指定します。これらのバージョンの違いの詳細については、Shell_NotifyIcon を参照してください。このメンバーは、Shell_NotifyIconNIM_SETVERSION メッセージを送信する場合にのみ使用されます。

公式ドキュメント

システムが通知領域に通知を表示するために必要な情報を格納します。Shell_NotifyIcon で使用されます。

解説(Remarks)

通知の UI とコンテンツに関するベストプラクティスの詳細については、Windows User Experience Interaction Guidelines の Notifications を参照してください。

uFlags メンバーに NIF_INFO フラグを設定すると、バルーン形式の通知が使用されます。これらの通知の詳細については、バルーンツールチップを参照してください。

タスクバーに対して同時に表示できるバルーン通知は 1 つだけです。既に通知が表示されているときにアプリケーションが別の通知を表示しようとすると、新しい通知はキューに入れられ、古い通知が消えた時点で表示されます。Windows Vista より前のバージョンの Windows では、元の通知の uTimeout 値にかかわらず、既存の通知がシステムの最小タイムアウト時間以上表示されるまで新しい通知は表示されませんでした。ユーザーがコンピューターを使用していないと見なされる場合、システムはその時間をタイムアウトに算入しません。

この構造体のいくつかのメンバーは Windows 2000 以降でのみサポートされます。これらのメンバーを有効にするには、ヘッダーに次の行のいずれかを含めます:

// Windows Vista and later:
#define NTDDI_VERSION NTDDI_WIN2K
#define NTDDI_VERSION NTDDI_WINXP
#define NTDDI_VERSION NTDDI_VISTA

// Windows XP and earlier:
#define _WIN32_IE 0x0500

構造体はそのサイズで初期化しなければならない点に注意してください。現在定義されている構造体のサイズを使用すると、より小さい構造体を想定する以前のバージョンの Shell32.dll ではアプリケーションが動作しない可能性があります。適切なバージョン番号を定義すれば、以前のバージョンの Shell32.dll に対してアプリケーションを実行できます (Shell and Common Controls Versions を参照)。ただし、アプリケーションがより新しいシステムでも動作する必要がある場合は、これが問題を引き起こすことがあります。

現在のヘッダーファイルを使用しながらすべての Shell32.dll バージョンとのアプリケーション互換性を維持するには、NOTIFYICONDATA 構造体のサイズを適切に設定します。構造体を初期化する前に、DllGetVersion を使用してシステムにインストールされている Shell32.dll のバージョンを確認し、次のいずれかの値で cbSize を初期化します:

Shell32.dll のバージョン cbSize
6.0.6 以降 (Windows Vista 以降) sizeof(NOTIFYICONDATA)
6.0 (Windows XP) NOTIFYICONDATA_V3_SIZE
5.0 (Windows 2000) NOTIFYICONDATA_V2_SIZE
5.0 より前のバージョン NOTIFYICONDATA_V1_SIZE

cbSize にこの値を使用することで、以前の Shell32.dll バージョンと互換性のある方法で NOTIFYICONDATA を使用できます。

次のコード例は、guidItem メンバーを使用するアプリケーションを Windows Vista と Windows 7 の両方で動作させるためのバージョンチェックを示しています。オペレーティングシステムが Windows 7 の場合に TRUE を返すブール関数を提供します。この関数が TRUE を返さない限り、guidItem メンバーは 0 に設定しなければなりません。

Note このコードは Windows 7 のバージョン番号に固有です。将来のバージョンの Windows および Windows Server では guidItem メンバーがサポートされる見込みであり、その時点ではこのコードを更新して、より新しいバージョン番号も有効と判定するようにする必要があります。
BOOL IsWin7OrLater()
{
    // Initialize the OSVERSIONINFOEX structure.
    OSVERSIONINFOEX osvi;
    ZeroMemory(&osvi, sizeof(OSVERSIONINFOEX));
    osvi.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
    osvi.dwMajorVersion = 6;
    osvi.dwMinorVersion = 1;

    // Initialize the condition mask.
    DWORDLONG dwlConditionMask = 0;
    VER_SET_CONDITION(dwlConditionMask, VER_MAJORVERSION, VER_GREATER_EQUAL);
    VER_SET_CONDITION(dwlConditionMask, VER_MINORVERSION, VER_GREATER_EQUAL);

    // Perform the test.
    return VerifyVersionInfo(&osvi, 
                             VER_MAJORVERSION | VER_MINORVERSION,
                             dwlConditionMask);
}

次のコード例は、高 DPI で使用するアイコンを読み込むための LoadIconMetric の使用方法を示しています。

// Declare NOTIFYICONDATA details. 
// Error handling is omitted here for brevity. Do not omit it in your code.

NOTIFYICONDATA nid = {};
nid.cbSize = sizeof(nid);
nid.hWnd = hWnd;
nid.uFlags = NIF_ICON | NIF_TIP | NIF_GUID;

// Note: This is an example GUID only and should not be used.
// Normally, you should use a GUID-generating tool to provide the value to
// assign to guidItem.
static const GUID myGUID = 
    {0x23977b55, 0x10e0, 0x4041, {0xb8, 0x62, 0xb1, 0x95, 0x41, 0x96, 0x36, 0x69}};
nid.guidItem = myGUID;

// This text will be shown as the icon's tooltip.
StringCchCopy(nid.szTip, ARRAYSIZE(nid.szTip), L"Test application");

// Load the icon for high DPI.
LoadIconMetric(hInst, MAKEINTRESOURCE(IDI_SMALL), LIM_SMALL, &(nid.hIcon));

// Show the notification.
Shell_NotifyIcon(NIM_ADD, &nid) ? S_OK : E_FAIL;

トラブルシューティング

guidItem メンバーを使用してアイコンを識別しているのにそのアイコンが表示されない場合や、Shell_NotifyIcon の一部の呼び出しが失敗する場合は、次のいずれかが原因である可能性が高いです:
  1. Shell_NotifyIcon のすべての呼び出しで NIF_GUID フラグが設定されていなかった。Shell_NotifyIcon の呼び出しで通知アイコンを GUID によって識別したら、同じアイコンを扱う以降の Shell_NotifyIcon の呼び出しでも、同じ GUID を使用してアイコンを識別しなければなりません。
  2. アイコンを含むバイナリファイルが移動された。バイナリファイルのパスはアイコンの GUID の登録に含まれており、変更できません。アイコンに関連付けられた設定は、ファイルパスと GUID が変更されない場合にのみアップグレード後も保持されます。パスを変更しなければならない場合、アプリケーションは既存のアイコンの登録時に追加された GUID 情報を削除する必要があります。その情報を削除した後であれば、バイナリファイルを新しい場所に移動し、新しい GUID で再登録できます。元の GUID 登録に関連付けられていた設定はすべて失われます。

    これはサイドバイサイドインストールの場合にも発生します。サイドバイサイドインストールを扱う場合、アプリケーションの新しいバージョンではバイナリファイルの GUID を更新する必要があります。

    Note ファイルが移動された場合の唯一の例外は、元のバイナリファイルと移動後のバイナリファイルの両方が同じ会社によって Authenticode 署名されている場合です。その場合、設定は移動後も保持されます。
メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして NOTIFYICONDATA を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則 を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// NOTIFYICONDATAW  (x64 968 / x86 956 バイト)
#pragma pack(push, 1)
typedef struct NOTIFYICONDATAW {
    DWORD cbSize;
    HWND hWnd;
    DWORD uID;
    NOTIFY_ICON_DATA_FLAGS uFlags;
    DWORD uCallbackMessage;
    HICON hIcon;
    WCHAR szTip[128];
    NOTIFY_ICON_STATE dwState;
    NOTIFY_ICON_STATE dwStateMask;
    WCHAR szInfo[256];
    _Anonymous_e__Union Anonymous;
    WCHAR szInfoTitle[64];
    NOTIFY_ICON_INFOTIP_FLAGS dwInfoFlags;
    GUID guidItem;
    HICON hBalloonIcon;
} NOTIFYICONDATAW;
#pragma pack(pop)
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct NOTIFYICONDATAW
{
    public uint cbSize;
    public IntPtr hWnd;
    public uint uID;
    public uint uFlags;
    public uint uCallbackMessage;
    public IntPtr hIcon;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)] public string szTip;
    public uint dwState;
    public uint dwStateMask;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 256)] public string szInfo;
    public _Anonymous_e__Union Anonymous;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)] public string szInfoTitle;
    public uint dwInfoFlags;
    public Guid guidItem;
    public IntPtr hBalloonIcon;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure NOTIFYICONDATAW
    Public cbSize As UInteger
    Public hWnd As IntPtr
    Public uID As UInteger
    Public uFlags As UInteger
    Public uCallbackMessage As UInteger
    Public hIcon As IntPtr
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=128)> Public szTip As String
    Public dwState As UInteger
    Public dwStateMask As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=256)> Public szInfo As String
    Public Anonymous As _Anonymous_e__Union
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=64)> Public szInfoTitle As String
    Public dwInfoFlags As UInteger
    Public guidItem As Guid
    Public hBalloonIcon As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class NOTIFYICONDATAW(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("cbSize", wintypes.DWORD),
        ("hWnd", ctypes.c_void_p),
        ("uID", wintypes.DWORD),
        ("uFlags", wintypes.DWORD),
        ("uCallbackMessage", wintypes.DWORD),
        ("hIcon", ctypes.c_void_p),
        ("szTip", ctypes.c_wchar * 128),
        ("dwState", wintypes.DWORD),
        ("dwStateMask", wintypes.DWORD),
        ("szInfo", ctypes.c_wchar * 256),
        ("Anonymous", _Anonymous_e__Union),
        ("szInfoTitle", ctypes.c_wchar * 64),
        ("dwInfoFlags", wintypes.DWORD),
        ("guidItem", GUID),
        ("hBalloonIcon", ctypes.c_void_p),
    ]
#[repr(C, packed(1))]
pub struct NOTIFYICONDATAW {
    pub cbSize: u32,
    pub hWnd: *mut core::ffi::c_void,
    pub uID: u32,
    pub uFlags: u32,
    pub uCallbackMessage: u32,
    pub hIcon: *mut core::ffi::c_void,
    pub szTip: [u16; 128],
    pub dwState: u32,
    pub dwStateMask: u32,
    pub szInfo: [u16; 256],
    pub Anonymous: _Anonymous_e__Union,
    pub szInfoTitle: [u16; 64],
    pub dwInfoFlags: u32,
    pub guidItem: GUID,
    pub hBalloonIcon: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type NOTIFYICONDATAW struct {
	cbSize uint32
	hWnd uintptr
	uID uint32
	uFlags uint32
	uCallbackMessage uint32
	hIcon uintptr
	szTip [128]uint16
	dwState uint32
	dwStateMask uint32
	szInfo [256]uint16
	Anonymous _Anonymous_e__Union
	szInfoTitle [64]uint16
	dwInfoFlags uint32
	guidItem windows.GUID
	hBalloonIcon uintptr
}
type
  NOTIFYICONDATAW = packed record
    cbSize: DWORD;
    hWnd: Pointer;
    uID: DWORD;
    uFlags: DWORD;
    uCallbackMessage: DWORD;
    hIcon: Pointer;
    szTip: array[0..127] of WideChar;
    dwState: DWORD;
    dwStateMask: DWORD;
    szInfo: array[0..255] of WideChar;
    Anonymous: _Anonymous_e__Union;
    szInfoTitle: array[0..63] of WideChar;
    dwInfoFlags: DWORD;
    guidItem: TGUID;
    hBalloonIcon: Pointer;
  end;
const NOTIFYICONDATAW = extern struct {
    cbSize: u32,
    hWnd: ?*anyopaque,
    uID: u32,
    uFlags: u32,
    uCallbackMessage: u32,
    hIcon: ?*anyopaque,
    szTip: [128]u16,
    dwState: u32,
    dwStateMask: u32,
    szInfo: [256]u16,
    Anonymous: _Anonymous_e__Union,
    szInfoTitle: [64]u16,
    dwInfoFlags: u32,
    guidItem: GUID,
    hBalloonIcon: ?*anyopaque,
};
type
  NOTIFYICONDATAW {.packed.} = object
    cbSize: uint32
    hWnd: pointer
    uID: uint32
    uFlags: uint32
    uCallbackMessage: uint32
    hIcon: pointer
    szTip: array[128, uint16]
    dwState: uint32
    dwStateMask: uint32
    szInfo: array[256, uint16]
    Anonymous: _Anonymous_e__Union
    szInfoTitle: array[64, uint16]
    dwInfoFlags: uint32
    guidItem: GUID
    hBalloonIcon: pointer
align(1)
struct NOTIFYICONDATAW
{
    uint cbSize;
    void* hWnd;
    uint uID;
    uint uFlags;
    uint uCallbackMessage;
    void* hIcon;
    wchar[128] szTip;
    uint dwState;
    uint dwStateMask;
    wchar[256] szInfo;
    _Anonymous_e__Union Anonymous;
    wchar[64] szInfoTitle;
    uint dwInfoFlags;
    GUID guidItem;
    void* hBalloonIcon;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; NOTIFYICONDATAW サイズ: 956 バイト(x86)
dim st, 239    ; 4byte整数×239(構造体サイズ 956 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hWnd : HWND (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; uID : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; uFlags : NOTIFY_ICON_DATA_FLAGS (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; uCallbackMessage : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; hIcon : HICON (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; szTip : WCHAR (+24, 256byte)  varptr(st)+24 を基点に操作(256byte:入れ子/配列)
; dwState : NOTIFY_ICON_STATE (+280, 4byte)  st.70 = 値  /  値 = st.70   (lpoke/lpeek も可)
; dwStateMask : NOTIFY_ICON_STATE (+284, 4byte)  st.71 = 値  /  値 = st.71   (lpoke/lpeek も可)
; szInfo : WCHAR (+288, 512byte)  varptr(st)+288 を基点に操作(512byte:入れ子/配列)
; Anonymous : _Anonymous_e__Union (+800, 4byte)  varptr(st)+800 を基点に操作(4byte:入れ子/配列)
; szInfoTitle : WCHAR (+804, 128byte)  varptr(st)+804 を基点に操作(128byte:入れ子/配列)
; dwInfoFlags : NOTIFY_ICON_INFOTIP_FLAGS (+932, 4byte)  st.233 = 値  /  値 = st.233   (lpoke/lpeek も可)
; guidItem : GUID (+936, 16byte)  varptr(st)+936 を基点に操作(16byte:入れ子/配列)
; hBalloonIcon : HICON (+952, 4byte)  st.238 = 値  /  値 = st.238   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; NOTIFYICONDATAW サイズ: 968 バイト(x64)
dim st, 242    ; 4byte整数×242(構造体サイズ 968 / 4 切り上げ)
; cbSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; hWnd : HWND (+4, 8byte)  qpoke st,4,値 / qpeek(st,4)  ※IronHSPのみ。3.7/3.8は lpoke st,4,下位 : lpoke st,8,上位
; uID : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; uFlags : NOTIFY_ICON_DATA_FLAGS (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; uCallbackMessage : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; hIcon : HICON (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; szTip : WCHAR (+32, 256byte)  varptr(st)+32 を基点に操作(256byte:入れ子/配列)
; dwState : NOTIFY_ICON_STATE (+288, 4byte)  st.72 = 値  /  値 = st.72   (lpoke/lpeek も可)
; dwStateMask : NOTIFY_ICON_STATE (+292, 4byte)  st.73 = 値  /  値 = st.73   (lpoke/lpeek も可)
; szInfo : WCHAR (+296, 512byte)  varptr(st)+296 を基点に操作(512byte:入れ子/配列)
; Anonymous : _Anonymous_e__Union (+808, 4byte)  varptr(st)+808 を基点に操作(4byte:入れ子/配列)
; szInfoTitle : WCHAR (+812, 128byte)  varptr(st)+812 を基点に操作(128byte:入れ子/配列)
; dwInfoFlags : NOTIFY_ICON_INFOTIP_FLAGS (+940, 4byte)  st.235 = 値  /  値 = st.235   (lpoke/lpeek も可)
; guidItem : GUID (+944, 16byte)  varptr(st)+944 を基点に操作(16byte:入れ子/配列)
; hBalloonIcon : HICON (+960, 8byte)  qpoke st,960,値 / qpeek(st,960)  ※IronHSPのみ。3.7/3.8は lpoke st,960,下位 : lpoke st,964,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global GUID, pack=1
    #field int Data1
    #field short Data2
    #field short Data3
    #field byte Data4 8
#endstruct

#defstruct global NOTIFYICONDATAW, pack=1
    #field int cbSize
    #field intptr hWnd
    #field int uID
    #field int uFlags
    #field int uCallbackMessage
    #field intptr hIcon
    #field wchar szTip 128
    #field int dwState
    #field int dwStateMask
    #field wchar szInfo 256
    #field byte Anonymous 4
    #field wchar szInfoTitle 64
    #field int dwInfoFlags
    #field GUID guidItem
    #field intptr hBalloonIcon
#endstruct

stdim st, NOTIFYICONDATAW        ; NSTRUCT 変数を確保
st->cbSize = 100
mes "cbSize=" + st->cbSize
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。