Shell_NotifyIconW
関数シグネチャ
// SHELL32.dll (Unicode / -W)
#include <windows.h>
BOOL Shell_NotifyIconW(
NOTIFY_ICON_MESSAGE dwMessage,
NOTIFYICONDATAW* lpData
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dwMessage | NOTIFY_ICON_MESSAGE | in | この関数が実行するアクションを指定する値です。次のいずれかの値を指定できます。 NIM_ADD (0x00000000)0x00000000。ステータス領域にアイコンを追加します。アイコンには、lpdata が指す NOTIFYICONDATA 構造体の uID メンバーまたは guidItem メンバーを通じて識別子が割り当てられます。この識別子は、以降の Shell_NotifyIcon の呼び出しで、そのアイコンに対する後続の操作を行うために使用されます。 NIM_MODIFY (0x00000001)0x00000001。ステータス領域のアイコンを変更します。lpdata が指す NOTIFYICONDATA 構造体は、アイコンが通知領域に追加された(NIM_ADD)際に最初に割り当てられた ID を使用して、変更対象のアイコンを識別します。 NIM_DELETE (0x00000002)0x00000002。ステータス領域からアイコンを削除します。lpdata が指す NOTIFYICONDATA 構造体は、アイコンが通知領域に追加された(NIM_ADD)際に最初に割り当てられた ID を使用して、削除対象のアイコンを識別します。 NIM_SETFOCUS (0x00000003)0x00000003。Shell32.dll バージョン 5.0 以降のみ。タスクバーの通知領域にフォーカスを戻します。通知領域アイコンは、UI 操作を完了したときにこのメッセージを使用します。たとえば、アイコンがショートカット メニューを表示したものの、ユーザーが ESC キーを押してキャンセルした場合は、NIM_SETFOCUS を使用してフォーカスを通知領域に戻します。 NIM_SETVERSION (0x00000004)0x00000004。Shell32.dll バージョン 5.0 以降のみ。lpdata が指す構造体の uVersion メンバーで指定されたバージョン番号に従って動作するよう、通知領域に指示します。バージョン番号は、どのメンバーが認識されるかを指定します。 NIM_SETVERSION は、通知領域アイコンを追加する(NIM_ADD)たびに呼び出す必要があります。NIM_MODIFY とともに呼び出す必要はありません。バージョン設定は、ユーザーがログオフすると保持されません。 詳細については、「解説」セクションを参照してください。 |
| lpData | NOTIFYICONDATAW* | in | NOTIFYICONDATA 構造体へのポインターです。構造体の内容は dwMessage の値によって異なります。通知領域に追加するアイコンを定義したり、そのアイコンに通知を表示させたり、変更または削除するアイコンを識別したりできます。 - dwMessage.NIM_ADD (0x00000000)0x00000000。ステータス領域にアイコンを追加します。アイコンには、lpdata が指す NOTIFYICONDATA 構造体の uID メンバーまたは guidItem メンバーを通じて識別子が割り当てられます。この識別子は、以降の Shell_NotifyIcon の呼び出しで、そのアイコンに対する後続の操作を行うために使用されます。 - dwMessage.NIM_DELETE (0x00000002)0x00000002。ステータス領域からアイコンを削除します。lpdata が指す NOTIFYICONDATA 構造体は、アイコンが通知領域に追加された(NIM_ADD)際に最初に割り当てられた ID を使用して、削除対象のアイコンを識別します。 - dwMessage.NIM_MODIFY (0x00000001)0x00000001。ステータス領域のアイコンを変更します。lpdata が指す NOTIFYICONDATA 構造体は、アイコンが通知領域に追加された(NIM_ADD)際に最初に割り当てられた ID を使用して、変更対象のアイコンを識別します。 - dwMessage.NIM_SETFOCUS (0x00000003)0x00000003。Shell32.dll バージョン 5.0 以降のみ。タスクバーの通知領域にフォーカスを戻します。通知領域アイコンは、UI 操作を完了したときにこのメッセージを使用します。たとえば、アイコンがショートカット メニューを表示したものの、ユーザーが ESC キーを押してキャンセルした場合は、NIM_SETFOCUS を使用してフォーカスを通知領域に戻します。 - dwMessage.NIM_SETVERSION (0x00000004)0x00000004。Shell32.dll バージョン 5.0 以降のみ。lpdata が指す構造体の uVersion メンバーで指定されたバージョン番号に従って動作するよう、通知領域に指示します。バージョン番号は、どのメンバーが認識されるかを指定します。 NIM_SETVERSION は、通知領域アイコンを追加する(NIM_ADD)たびに呼び出す必要があります>。NIM_MODIFY とともに呼び出す必要はありません。バージョン設定は、ユーザーがログオフすると保持されません。 詳細については、「解説」セクションを参照してください。 |
戻り値の型: BOOL
公式ドキュメント
タスクバーのステータス領域(通知領域)にメッセージを送信します。(Unicode)
戻り値
型: BOOL
成功した場合は TRUE を、それ以外の場合は FALSE を返します。dwMessage に NIM_SETVERSION が設定されている場合、バージョンの変更に成功すると TRUE を、要求されたバージョンがサポートされていない場合は FALSE を返します。
解説(Remarks)
Windows 2000(Shell32.dll バージョン 5.0)以降では、lpdata が指す NOTIFYICONDATA 構造体の uVersion メンバーを NOTIFYICON_VERSION_4 以上に設定すると、Shell_NotifyIcon のマウス イベントおよびキーボード イベントの処理が、以前のバージョンの Windows とは異なります。違いには次のものがあります。
- ユーザーがキーボードで通知アイコンのショートカット メニューを選択した場合、シェルは関連付けられたアプリケーションに WM_CONTEXTMENU メッセージを送信するようになりました。以前のバージョンでは WM_RBUTTONDOWN および WM_RBUTTONUP メッセージを送信します。
- ユーザーがキーボードで通知アイコンを選択し、スペース キーまたは Enter キーでアクティブ化した場合、バージョン 5.0 のシェルは関連付けられたアプリケーションに NIN_KEYSELECT 通知を送信します。以前のバージョンでは WM_RBUTTONDOWN および WM_RBUTTONUP メッセージを送信します。
- ユーザーがマウスで通知アイコンを選択し、Enter キーでアクティブ化した場合、シェルは関連付けられたアプリケーションに NIN_SELECT 通知を送信するようになりました。以前のバージョンでは WM_RBUTTONDOWN および WM_RBUTTONUP メッセージを送信します。
- NIN_BALLOONSHOW。バルーンが表示されたときに送信されます(バルーンはキューに入れられます)。
-
NIN_BALLOONHIDE。バルーンが消えたとき(たとえばアイコンが削除されたとき)に送信されます。このメッセージは、タイムアウトによってバルーンが閉じた場合や、ユーザーがマウスをクリックした場合には送信されません。
Windows 7 以降では、NIIF_RESPECT_QUIET_TIME フラグが設定された通知がクワイエット タイム(ユーザーが新しいコンピューターを使い始めてから最初の 1 時間)中に表示されようとした場合にも、NIN_BALLOONHIDE が送信されます。この場合、バルーンはまったく表示されません。
- NIN_BALLOONTIMEOUT。タイムアウトによってバルーンが閉じたときに送信されます。
- NIN_BALLOONUSERCLICK。ユーザーがマウスをクリックしてバルーンを閉じたときに送信されます。
- NIN_POPUPOPEN。ユーザーがアイコンの上にカーソルを置いたときに送信され、標準のテキスト ツールチップに代わってより充実したポップアップ UI を使用すべきであることを示します。
- NIN_POPUPCLOSE。カーソルがアイコンの上から外れたときに送信され、リッチなポップアップ UI を閉じるべきであることを示します。
shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして Shell_NotifyIcon を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイル エラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll (Unicode / -W)
#include <windows.h>
BOOL Shell_NotifyIconW(
NOTIFY_ICON_MESSAGE dwMessage,
NOTIFYICONDATAW* lpData
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool Shell_NotifyIconW(
uint dwMessage, // NOTIFY_ICON_MESSAGE
IntPtr lpData // NOTIFYICONDATAW*
);<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function Shell_NotifyIconW(
dwMessage As UInteger, ' NOTIFY_ICON_MESSAGE
lpData As IntPtr ' NOTIFYICONDATAW*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' dwMessage : NOTIFY_ICON_MESSAGE
' lpData : NOTIFYICONDATAW*
Declare PtrSafe Function Shell_NotifyIconW Lib "shell32" ( _
ByVal dwMessage As Long, _
ByVal lpData As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
Shell_NotifyIconW = ctypes.windll.shell32.Shell_NotifyIconW
Shell_NotifyIconW.restype = wintypes.BOOL
Shell_NotifyIconW.argtypes = [
wintypes.DWORD, # dwMessage : NOTIFY_ICON_MESSAGE
ctypes.c_void_p, # lpData : NOTIFYICONDATAW*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
Shell_NotifyIconW = Fiddle::Function.new(
lib['Shell_NotifyIconW'],
[
-Fiddle::TYPE_INT, # dwMessage : NOTIFY_ICON_MESSAGE
Fiddle::TYPE_VOIDP, # lpData : NOTIFYICONDATAW*
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "shell32")]
extern "system" {
fn Shell_NotifyIconW(
dwMessage: u32, // NOTIFY_ICON_MESSAGE
lpData: *mut NOTIFYICONDATAW // NOTIFYICONDATAW*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern bool Shell_NotifyIconW(uint dwMessage, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_Shell_NotifyIconW' -Namespace Win32 -PassThru
# $api::Shell_NotifyIconW(dwMessage, lpData)#uselib "SHELL32.dll"
#func global Shell_NotifyIconW "Shell_NotifyIconW" wptr, wptr
; Shell_NotifyIconW dwMessage, varptr(lpData) ; 戻り値は stat
; dwMessage : NOTIFY_ICON_MESSAGE -> "wptr"
; lpData : NOTIFYICONDATAW* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll" #cfunc global Shell_NotifyIconW "Shell_NotifyIconW" int, var ; res = Shell_NotifyIconW(dwMessage, lpData) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global Shell_NotifyIconW "Shell_NotifyIconW" int, sptr ; res = Shell_NotifyIconW(dwMessage, varptr(lpData)) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAW* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL Shell_NotifyIconW(NOTIFY_ICON_MESSAGE dwMessage, NOTIFYICONDATAW* lpData) #uselib "SHELL32.dll" #cfunc global Shell_NotifyIconW "Shell_NotifyIconW" int, var ; res = Shell_NotifyIconW(dwMessage, lpData) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAW* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL Shell_NotifyIconW(NOTIFY_ICON_MESSAGE dwMessage, NOTIFYICONDATAW* lpData) #uselib "SHELL32.dll" #cfunc global Shell_NotifyIconW "Shell_NotifyIconW" int, intptr ; res = Shell_NotifyIconW(dwMessage, varptr(lpData)) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAW* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procShell_NotifyIconW = shell32.NewProc("Shell_NotifyIconW")
)
// dwMessage (NOTIFY_ICON_MESSAGE), lpData (NOTIFYICONDATAW*)
r1, _, err := procShell_NotifyIconW.Call(
uintptr(dwMessage),
uintptr(lpData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction Shell_NotifyIconW(
dwMessage: DWORD; // NOTIFY_ICON_MESSAGE
lpData: Pointer // NOTIFYICONDATAW*
): BOOL; stdcall;
external 'SHELL32.dll' name 'Shell_NotifyIconW';result := DllCall("SHELL32\Shell_NotifyIconW"
, "UInt", dwMessage ; NOTIFY_ICON_MESSAGE
, "Ptr", lpData ; NOTIFYICONDATAW*
, "Int") ; return: BOOL●Shell_NotifyIconW(dwMessage, lpData) = DLL("SHELL32.dll", "bool Shell_NotifyIconW(dword, void*)")
# 呼び出し: Shell_NotifyIconW(dwMessage, lpData)
# dwMessage : NOTIFY_ICON_MESSAGE -> "dword"
# lpData : NOTIFYICONDATAW* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "shell32" fn Shell_NotifyIconW(
dwMessage: u32, // NOTIFY_ICON_MESSAGE
lpData: [*c]NOTIFYICONDATAW // NOTIFYICONDATAW*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc Shell_NotifyIconW(
dwMessage: uint32, # NOTIFY_ICON_MESSAGE
lpData: ptr NOTIFYICONDATAW # NOTIFYICONDATAW*
): int32 {.importc: "Shell_NotifyIconW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "shell32");
extern(Windows)
int Shell_NotifyIconW(
uint dwMessage, // NOTIFY_ICON_MESSAGE
NOTIFYICONDATAW* lpData // NOTIFYICONDATAW*
);ccall((:Shell_NotifyIconW, "SHELL32.dll"), stdcall, Int32,
(UInt32, Ptr{NOTIFYICONDATAW}),
dwMessage, lpData)
# dwMessage : NOTIFY_ICON_MESSAGE -> UInt32
# lpData : NOTIFYICONDATAW* -> Ptr{NOTIFYICONDATAW}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t Shell_NotifyIconW(
uint32_t dwMessage,
void* lpData);
]]
local shell32 = ffi.load("shell32")
-- shell32.Shell_NotifyIconW(dwMessage, lpData)
-- dwMessage : NOTIFY_ICON_MESSAGE
-- lpData : NOTIFYICONDATAW*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const Shell_NotifyIconW = lib.func('__stdcall', 'Shell_NotifyIconW', 'int32_t', ['uint32_t', 'void *']);
// Shell_NotifyIconW(dwMessage, lpData)
// dwMessage : NOTIFY_ICON_MESSAGE -> 'uint32_t'
// lpData : NOTIFYICONDATAW* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
Shell_NotifyIconW: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.Shell_NotifyIconW(dwMessage, lpData)
// dwMessage : NOTIFY_ICON_MESSAGE -> "u32"
// lpData : NOTIFYICONDATAW* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t Shell_NotifyIconW(
uint32_t dwMessage,
void* lpData);
C, "SHELL32.dll");
// $ffi->Shell_NotifyIconW(dwMessage, lpData);
// dwMessage : NOTIFY_ICON_MESSAGE
// lpData : NOTIFYICONDATAW*
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Shell32 extends StdCallLibrary {
Shell32 INSTANCE = Native.load("shell32", Shell32.class, W32APIOptions.UNICODE_OPTIONS);
boolean Shell_NotifyIconW(
int dwMessage, // NOTIFY_ICON_MESSAGE
Pointer lpData // NOTIFYICONDATAW*
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("shell32")]
lib LibSHELL32
fun Shell_NotifyIconW = Shell_NotifyIconW(
dwMessage : UInt32, # NOTIFY_ICON_MESSAGE
lpData : NOTIFYICONDATAW* # NOTIFYICONDATAW*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef Shell_NotifyIconWNative = Int32 Function(Uint32, Pointer<Void>);
typedef Shell_NotifyIconWDart = int Function(int, Pointer<Void>);
final Shell_NotifyIconW = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<Shell_NotifyIconWNative, Shell_NotifyIconWDart>('Shell_NotifyIconW');
// dwMessage : NOTIFY_ICON_MESSAGE -> Uint32
// lpData : NOTIFYICONDATAW* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function Shell_NotifyIconW(
dwMessage: DWORD; // NOTIFY_ICON_MESSAGE
lpData: Pointer // NOTIFYICONDATAW*
): BOOL; stdcall;
external 'SHELL32.dll' name 'Shell_NotifyIconW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "Shell_NotifyIconW"
c_Shell_NotifyIconW :: Word32 -> Ptr () -> IO CInt
-- dwMessage : NOTIFY_ICON_MESSAGE -> Word32
-- lpData : NOTIFYICONDATAW* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shell_notifyiconw =
foreign "Shell_NotifyIconW"
(uint32_t @-> (ptr void) @-> returning int32_t)
(* dwMessage : NOTIFY_ICON_MESSAGE -> uint32_t *)
(* lpData : NOTIFYICONDATAW* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("Shell_NotifyIconW" shell-notify-icon-w :convention :stdcall) :int32
(dw-message :uint32) ; NOTIFY_ICON_MESSAGE
(lp-data :pointer)) ; NOTIFYICONDATAW*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $Shell_NotifyIconW = Win32::API::More->new('SHELL32',
'BOOL Shell_NotifyIconW(DWORD dwMessage, LPVOID lpData)');
# my $ret = $Shell_NotifyIconW->Call($dwMessage, $lpData);
# dwMessage : NOTIFY_ICON_MESSAGE -> DWORD
# lpData : NOTIFYICONDATAW* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
- f Shell_NotifyIconA (ANSI版) — タスクトレイの通知アイコンを追加・変更・削除する。