Shell_NotifyIconA
関数シグネチャ
// SHELL32.dll (ANSI / -A)
#include <windows.h>
BOOL Shell_NotifyIconA(
NOTIFY_ICON_MESSAGE dwMessage,
NOTIFYICONDATAA* 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 | NOTIFYICONDATAA* | in | NOTIFYICONDATA 構造体へのポインターです。構造体の内容は dwMessage の値によって異なります。通知領域に追加するアイコンを定義したり、そのアイコンに通知を表示させたり、変更または削除するアイコンを識別したりできます。 |
戻り値の型: BOOL
公式ドキュメント
タスクバーのステータス領域(通知領域)にメッセージを送信します。(ANSI)
戻り値
型: 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 (ANSI / -A)
#include <windows.h>
BOOL Shell_NotifyIconA(
NOTIFY_ICON_MESSAGE dwMessage,
NOTIFYICONDATAA* lpData
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool Shell_NotifyIconA(
uint dwMessage, // NOTIFY_ICON_MESSAGE
IntPtr lpData // NOTIFYICONDATAA*
);<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function Shell_NotifyIconA(
dwMessage As UInteger, ' NOTIFY_ICON_MESSAGE
lpData As IntPtr ' NOTIFYICONDATAA*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' dwMessage : NOTIFY_ICON_MESSAGE
' lpData : NOTIFYICONDATAA*
Declare PtrSafe Function Shell_NotifyIconA Lib "shell32" ( _
ByVal dwMessage As Long, _
ByVal lpData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
Shell_NotifyIconA = ctypes.windll.shell32.Shell_NotifyIconA
Shell_NotifyIconA.restype = wintypes.BOOL
Shell_NotifyIconA.argtypes = [
wintypes.DWORD, # dwMessage : NOTIFY_ICON_MESSAGE
ctypes.c_void_p, # lpData : NOTIFYICONDATAA*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
Shell_NotifyIconA = Fiddle::Function.new(
lib['Shell_NotifyIconA'],
[
-Fiddle::TYPE_INT, # dwMessage : NOTIFY_ICON_MESSAGE
Fiddle::TYPE_VOIDP, # lpData : NOTIFYICONDATAA*
],
Fiddle::TYPE_INT)#[link(name = "shell32")]
extern "system" {
fn Shell_NotifyIconA(
dwMessage: u32, // NOTIFY_ICON_MESSAGE
lpData: *mut NOTIFYICONDATAA // NOTIFYICONDATAA*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern bool Shell_NotifyIconA(uint dwMessage, IntPtr lpData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_Shell_NotifyIconA' -Namespace Win32 -PassThru
# $api::Shell_NotifyIconA(dwMessage, lpData)#uselib "SHELL32.dll"
#func global Shell_NotifyIconA "Shell_NotifyIconA" sptr, sptr
; Shell_NotifyIconA dwMessage, varptr(lpData) ; 戻り値は stat
; dwMessage : NOTIFY_ICON_MESSAGE -> "sptr"
; lpData : NOTIFYICONDATAA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "SHELL32.dll" #cfunc global Shell_NotifyIconA "Shell_NotifyIconA" int, var ; res = Shell_NotifyIconA(dwMessage, lpData) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAA* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global Shell_NotifyIconA "Shell_NotifyIconA" int, sptr ; res = Shell_NotifyIconA(dwMessage, varptr(lpData)) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAA* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; BOOL Shell_NotifyIconA(NOTIFY_ICON_MESSAGE dwMessage, NOTIFYICONDATAA* lpData) #uselib "SHELL32.dll" #cfunc global Shell_NotifyIconA "Shell_NotifyIconA" int, var ; res = Shell_NotifyIconA(dwMessage, lpData) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAA* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL Shell_NotifyIconA(NOTIFY_ICON_MESSAGE dwMessage, NOTIFYICONDATAA* lpData) #uselib "SHELL32.dll" #cfunc global Shell_NotifyIconA "Shell_NotifyIconA" int, intptr ; res = Shell_NotifyIconA(dwMessage, varptr(lpData)) ; dwMessage : NOTIFY_ICON_MESSAGE -> "int" ; lpData : NOTIFYICONDATAA* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procShell_NotifyIconA = shell32.NewProc("Shell_NotifyIconA")
)
// dwMessage (NOTIFY_ICON_MESSAGE), lpData (NOTIFYICONDATAA*)
r1, _, err := procShell_NotifyIconA.Call(
uintptr(dwMessage),
uintptr(lpData),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction Shell_NotifyIconA(
dwMessage: DWORD; // NOTIFY_ICON_MESSAGE
lpData: Pointer // NOTIFYICONDATAA*
): BOOL; stdcall;
external 'SHELL32.dll' name 'Shell_NotifyIconA';result := DllCall("SHELL32\Shell_NotifyIconA"
, "UInt", dwMessage ; NOTIFY_ICON_MESSAGE
, "Ptr", lpData ; NOTIFYICONDATAA*
, "Int") ; return: BOOL●Shell_NotifyIconA(dwMessage, lpData) = DLL("SHELL32.dll", "bool Shell_NotifyIconA(dword, void*)")
# 呼び出し: Shell_NotifyIconA(dwMessage, lpData)
# dwMessage : NOTIFY_ICON_MESSAGE -> "dword"
# lpData : NOTIFYICONDATAA* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shell32" fn Shell_NotifyIconA(
dwMessage: u32, // NOTIFY_ICON_MESSAGE
lpData: [*c]NOTIFYICONDATAA // NOTIFYICONDATAA*
) callconv(std.os.windows.WINAPI) i32;proc Shell_NotifyIconA(
dwMessage: uint32, # NOTIFY_ICON_MESSAGE
lpData: ptr NOTIFYICONDATAA # NOTIFYICONDATAA*
): int32 {.importc: "Shell_NotifyIconA", stdcall, dynlib: "SHELL32.dll".}pragma(lib, "shell32");
extern(Windows)
int Shell_NotifyIconA(
uint dwMessage, // NOTIFY_ICON_MESSAGE
NOTIFYICONDATAA* lpData // NOTIFYICONDATAA*
);ccall((:Shell_NotifyIconA, "SHELL32.dll"), stdcall, Int32,
(UInt32, Ptr{NOTIFYICONDATAA}),
dwMessage, lpData)
# dwMessage : NOTIFY_ICON_MESSAGE -> UInt32
# lpData : NOTIFYICONDATAA* -> Ptr{NOTIFYICONDATAA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t Shell_NotifyIconA(
uint32_t dwMessage,
void* lpData);
]]
local shell32 = ffi.load("shell32")
-- shell32.Shell_NotifyIconA(dwMessage, lpData)
-- dwMessage : NOTIFY_ICON_MESSAGE
-- lpData : NOTIFYICONDATAA*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const Shell_NotifyIconA = lib.func('__stdcall', 'Shell_NotifyIconA', 'int32_t', ['uint32_t', 'void *']);
// Shell_NotifyIconA(dwMessage, lpData)
// dwMessage : NOTIFY_ICON_MESSAGE -> 'uint32_t'
// lpData : NOTIFYICONDATAA* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
Shell_NotifyIconA: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.Shell_NotifyIconA(dwMessage, lpData)
// dwMessage : NOTIFY_ICON_MESSAGE -> "u32"
// lpData : NOTIFYICONDATAA* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t Shell_NotifyIconA(
uint32_t dwMessage,
void* lpData);
C, "SHELL32.dll");
// $ffi->Shell_NotifyIconA(dwMessage, lpData);
// dwMessage : NOTIFY_ICON_MESSAGE
// lpData : NOTIFYICONDATAA*
// 構造体/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.ASCII_OPTIONS);
boolean Shell_NotifyIconA(
int dwMessage, // NOTIFY_ICON_MESSAGE
Pointer lpData // NOTIFYICONDATAA*
);
}@[Link("shell32")]
lib LibSHELL32
fun Shell_NotifyIconA = Shell_NotifyIconA(
dwMessage : UInt32, # NOTIFY_ICON_MESSAGE
lpData : NOTIFYICONDATAA* # NOTIFYICONDATAA*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef Shell_NotifyIconANative = Int32 Function(Uint32, Pointer<Void>);
typedef Shell_NotifyIconADart = int Function(int, Pointer<Void>);
final Shell_NotifyIconA = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<Shell_NotifyIconANative, Shell_NotifyIconADart>('Shell_NotifyIconA');
// dwMessage : NOTIFY_ICON_MESSAGE -> Uint32
// lpData : NOTIFYICONDATAA* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function Shell_NotifyIconA(
dwMessage: DWORD; // NOTIFY_ICON_MESSAGE
lpData: Pointer // NOTIFYICONDATAA*
): BOOL; stdcall;
external 'SHELL32.dll' name 'Shell_NotifyIconA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "Shell_NotifyIconA"
c_Shell_NotifyIconA :: Word32 -> Ptr () -> IO CInt
-- dwMessage : NOTIFY_ICON_MESSAGE -> Word32
-- lpData : NOTIFYICONDATAA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shell_notifyicona =
foreign "Shell_NotifyIconA"
(uint32_t @-> (ptr void) @-> returning int32_t)
(* dwMessage : NOTIFY_ICON_MESSAGE -> uint32_t *)
(* lpData : NOTIFYICONDATAA* -> (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_NotifyIconA" shell-notify-icon-a :convention :stdcall) :int32
(dw-message :uint32) ; NOTIFY_ICON_MESSAGE
(lp-data :pointer)) ; NOTIFYICONDATAA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $Shell_NotifyIconA = Win32::API::More->new('SHELL32',
'BOOL Shell_NotifyIconA(DWORD dwMessage, LPVOID lpData)');
# my $ret = $Shell_NotifyIconA->Call($dwMessage, $lpData);
# dwMessage : NOTIFY_ICON_MESSAGE -> DWORD
# lpData : NOTIFYICONDATAA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f Shell_NotifyIconW (Unicode版) — タスクトレイの通知アイコンを追加・変更・削除する。