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

SHChangeNotify

関数
シェルにファイルやフォルダーの変更イベントを通知する。
DLLSHELL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll
#include <windows.h>

void SHChangeNotify(
    INT wEventId,
    SHCNF_FLAGS uFlags,
    const void* dwItem1,   // optional
    const void* dwItem2   // optional
);

パラメーター

名前方向説明
wEventIdINTin

発生したイベントを示します。通常は一度に 1 つのイベントのみを指定します。複数のイベントを指定する場合、指定したすべてのイベントについて、dwItem1 および dwItem2 パラメーターに含まれる値はそれぞれ同一である必要があります。このパラメーターには、次の値を 1 つ以上指定できます。

SHCNE_ALLEVENTS

すべてのイベントが発生しました。

SHCNE_ASSOCCHANGED

ファイルの種類の関連付けが変更されました。uFlags パラメーターに SHCNF_IDLIST を指定する必要があります。dwItem1 および dwItem2 は使用されず、NULL である必要があります。このイベントは、登録されたプロトコルに対しても送信してください。

SHCNE_ATTRIBUTES

項目またはフォルダーの属性が変更されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には変更された項目またはフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_CREATE

フォルダー以外の項目が作成されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には作成された項目が含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_DELETE

フォルダー以外の項目が削除されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には削除された項目が含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_DRIVEADD

ドライブが追加されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には追加されたドライブのルートが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_DRIVEADDGUI

Windows XP 以降: 使用されません。

SHCNE_DRIVEREMOVED

ドライブが削除されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には削除されたドライブのルートが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_EXTENDED_EVENT

現在は使用されていません。

SHCNE_FREESPACE

ドライブの空き容量が変更されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には空き容量が変更されたドライブのルートが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_MEDIAINSERTED

記憶メディアがドライブに挿入されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には新しいメディアを含むドライブのルートが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_MEDIAREMOVED

記憶メディアがドライブから取り出されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 にはメディアが取り出されたドライブのルートが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_MKDIR

フォルダーが作成されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には作成されたフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_NETSHARE

ローカルコンピューター上のフォルダーがネットワーク経由で共有されています。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には共有されているフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_NETUNSHARE

ローカルコンピューター上のフォルダーがネットワーク経由で共有されなくなりました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には共有されなくなったフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_RENAMEFOLDER

フォルダーの名前が変更されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 にはフォルダーの以前の PIDL または名前が含まれます。dwItem2 にはフォルダーの新しい PIDL または名前が含まれます。

SHCNE_RENAMEITEM

フォルダー以外の項目の名前が変更されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には項目の以前の PIDL または名前が含まれます。dwItem2 には項目の新しい PIDL または名前が含まれます。

SHCNE_RMDIR

フォルダーが削除されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には削除されたフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_SERVERDISCONNECT

コンピューターがサーバーから切断されました。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 にはコンピューターが切断されたサーバーが含まれます。dwItem2 は使用されず、NULL である必要があります。

SHCNE_UPDATEDIR

既存のフォルダーの内容が変更されましたが、フォルダー自体は依然として存在し、名前も変更されていません。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には変更されたフォルダーが含まれます。dwItem2 は使用されず、NULL である必要があります。フォルダーが作成、削除、または名前変更された場合は、それぞれ SHCNE_MKDIRSHCNE_RMDIRSHCNE_RENAMEFOLDER を使用してください。

SHCNE_UPDATEIMAGE

システムイメージリスト内のイメージが変更されました。uFlagsSHCNF_DWORD を指定する必要があります。

dwItem2 には変更されたシステムイメージリスト内のインデックスが含まれます。dwItem1 は使用されず、NULL である必要があります。

SHCNE_UPDATEITEM

既存の項目(フォルダーまたはフォルダー以外の項目)が変更されましたが、項目自体は依然として存在し、名前も変更されていません。uFlagsSHCNF_IDLIST または SHCNF_PATH を指定する必要があります。dwItem1 には変更された項目が含まれます。dwItem2 は使用されず、NULL である必要があります。フォルダー以外の項目が作成、削除、または名前変更された場合は、代わりにそれぞれ SHCNE_CREATESHCNE_DELETESHCNE_RENAMEITEM を使用してください。

SHCNE_DISKEVENTS

すべてのディスクイベント識別子の組み合わせを指定します。

SHCNE_GLOBALEVENTS

すべてのグローバルイベント識別子の組み合わせを指定します。

SHCNE_INTERRUPT

指定されたイベントがシステム割り込みの結果として発生したことを示します。この値は他のイベント値を修飾するものであるため、単独では使用できません。

uFlagsSHCNF_FLAGSin

SHCNF_TYPE とビット単位で組み合わせることで、dwItem1 および dwItem2 パラメーターの意味を示すフラグです。uFlags パラメーターには、次のいずれかの値を指定する必要があります。

SHCNF_DWORD

dwItem1 および dwItem2 パラメーターは DWORD 値です。

SHCNF_IDLIST

dwItem1 および dwItem2 は、変更の影響を受ける項目を表す ITEMIDLIST 構造体のアドレスです。各 ITEMIDLIST はデスクトップフォルダーからの相対指定である必要があります。

SHCNF_PATH

dwItem1 および dwItem2 は、変更の影響を受ける項目のフルパス名を含む、最大長 MAX_PATH の null 終端文字列のアドレスです。

SHCNF_PRINTER

dwItem1 および dwItem2 は、変更の影響を受けるプリンターのフレンドリ名を表す null 終端文字列のアドレスです。

SHCNF_FLUSH

通知が影響を受けるすべてのコンポーネントに配信されるまで、関数は戻りません。このフラグは他のデータ型フラグを修飾するものであるため、単独では使用できません。

SHCNF_FLUSHNOWAIT

関数は影響を受けるすべてのコンポーネントへの通知の配信を開始しますが、通知処理が開始され次第すぐに戻ります。このフラグは他のデータ型フラグを修飾するものであるため、単独では使用できません。このフラグは SHCNF_FLUSH を含みます。

SHCNF_NOTIFYRECURSIVE

すべての子に対して登録されているクライアントに通知します。

dwItem1void*inoptional省略可能。1 つ目のイベント依存の値です。
dwItem2void*inoptional省略可能。2 つ目のイベント依存の値です。

戻り値の型: void

公式ドキュメント

アプリケーションが実行したイベントをシステムに通知します。Shell に影響を与える可能性のある操作を行う場合、アプリケーションはこの関数を使用してください。

解説(Remarks)

任意の種類の新しいハンドラーを登録するアプリケーションは、SHCNE_ASSOCCHANGED フラグを指定して SHChangeNotify を呼び出し、アイコンおよびサムネイルのキャッシュを無効化するよう Shell に指示する必要があります。これにより、登録された新しいアイコンハンドラーおよびサムネイルハンドラーも読み込まれます。ただし、アイコンオーバーレイハンドラーは再読み込みされない点に注意してください。

dwItem1 および dwItem2 が指す文字列は、ANSI または Unicode のいずれでもかまいません。

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

各言語での呼び出し定義

// SHELL32.dll
#include <windows.h>

void SHChangeNotify(
    INT wEventId,
    SHCNF_FLAGS uFlags,
    const void* dwItem1,   // optional
    const void* dwItem2   // optional
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern void SHChangeNotify(
    int wEventId,   // INT
    uint uFlags,   // SHCNF_FLAGS
    IntPtr dwItem1,   // void* optional
    IntPtr dwItem2   // void* optional
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Sub SHChangeNotify(
    wEventId As Integer,   ' INT
    uFlags As UInteger,   ' SHCNF_FLAGS
    dwItem1 As IntPtr,   ' void* optional
    dwItem2 As IntPtr   ' void* optional
)
End Sub
' wEventId : INT
' uFlags : SHCNF_FLAGS
' dwItem1 : void* optional
' dwItem2 : void* optional
Declare PtrSafe Sub SHChangeNotify Lib "shell32" ( _
    ByVal wEventId As Long, _
    ByVal uFlags As Long, _
    ByVal dwItem1 As LongPtr, _
    ByVal dwItem2 As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHChangeNotify = ctypes.windll.shell32.SHChangeNotify
SHChangeNotify.restype = None
SHChangeNotify.argtypes = [
    ctypes.c_int,  # wEventId : INT
    wintypes.DWORD,  # uFlags : SHCNF_FLAGS
    ctypes.POINTER(None),  # dwItem1 : void* optional
    ctypes.POINTER(None),  # dwItem2 : void* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHChangeNotify = Fiddle::Function.new(
  lib['SHChangeNotify'],
  [
    Fiddle::TYPE_INT,  # wEventId : INT
    -Fiddle::TYPE_INT,  # uFlags : SHCNF_FLAGS
    Fiddle::TYPE_VOIDP,  # dwItem1 : void* optional
    Fiddle::TYPE_VOIDP,  # dwItem2 : void* optional
  ],
  Fiddle::TYPE_VOID)
#[link(name = "shell32")]
extern "system" {
    fn SHChangeNotify(
        wEventId: i32,  // INT
        uFlags: u32,  // SHCNF_FLAGS
        dwItem1: *const (),  // void* optional
        dwItem2: *const ()  // void* optional
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern void SHChangeNotify(int wEventId, uint uFlags, IntPtr dwItem1, IntPtr dwItem2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHChangeNotify' -Namespace Win32 -PassThru
# $api::SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2)
#uselib "SHELL32.dll"
#func global SHChangeNotify "SHChangeNotify" sptr, sptr, sptr, sptr
; SHChangeNotify wEventId, uFlags, dwItem1, dwItem2
; wEventId : INT -> "sptr"
; uFlags : SHCNF_FLAGS -> "sptr"
; dwItem1 : void* optional -> "sptr"
; dwItem2 : void* optional -> "sptr"
#uselib "SHELL32.dll"
#func global SHChangeNotify "SHChangeNotify" int, int, sptr, sptr
; SHChangeNotify wEventId, uFlags, dwItem1, dwItem2
; wEventId : INT -> "int"
; uFlags : SHCNF_FLAGS -> "int"
; dwItem1 : void* optional -> "sptr"
; dwItem2 : void* optional -> "sptr"
; void SHChangeNotify(INT wEventId, SHCNF_FLAGS uFlags, void* dwItem1, void* dwItem2)
#uselib "SHELL32.dll"
#func global SHChangeNotify "SHChangeNotify" int, int, intptr, intptr
; SHChangeNotify wEventId, uFlags, dwItem1, dwItem2
; wEventId : INT -> "int"
; uFlags : SHCNF_FLAGS -> "int"
; dwItem1 : void* optional -> "intptr"
; dwItem2 : void* optional -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHChangeNotify = shell32.NewProc("SHChangeNotify")
)

// wEventId (INT), uFlags (SHCNF_FLAGS), dwItem1 (void* optional), dwItem2 (void* optional)
r1, _, err := procSHChangeNotify.Call(
	uintptr(wEventId),
	uintptr(uFlags),
	uintptr(dwItem1),
	uintptr(dwItem2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure SHChangeNotify(
  wEventId: Integer;   // INT
  uFlags: DWORD;   // SHCNF_FLAGS
  dwItem1: Pointer;   // void* optional
  dwItem2: Pointer   // void* optional
); stdcall;
  external 'SHELL32.dll' name 'SHChangeNotify';
result := DllCall("SHELL32\SHChangeNotify"
    , "Int", wEventId   ; INT
    , "UInt", uFlags   ; SHCNF_FLAGS
    , "Ptr", dwItem1   ; void* optional
    , "Ptr", dwItem2   ; void* optional
    , "Int")   ; return: void
●SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2) = DLL("SHELL32.dll", "int SHChangeNotify(int, dword, void*, void*)")
# 呼び出し: SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2)
# wEventId : INT -> "int"
# uFlags : SHCNF_FLAGS -> "dword"
# dwItem1 : void* optional -> "void*"
# dwItem2 : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn SHChangeNotify(
    wEventId: i32, // INT
    uFlags: u32, // SHCNF_FLAGS
    dwItem1: ?*anyopaque, // void* optional
    dwItem2: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) void;
proc SHChangeNotify(
    wEventId: int32,  # INT
    uFlags: uint32,  # SHCNF_FLAGS
    dwItem1: pointer,  # void* optional
    dwItem2: pointer  # void* optional
) {.importc: "SHChangeNotify", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
void SHChangeNotify(
    int wEventId,   // INT
    uint uFlags,   // SHCNF_FLAGS
    void* dwItem1,   // void* optional
    void* dwItem2   // void* optional
);
ccall((:SHChangeNotify, "SHELL32.dll"), stdcall, Cvoid,
      (Int32, UInt32, Ptr{Cvoid}, Ptr{Cvoid}),
      wEventId, uFlags, dwItem1, dwItem2)
# wEventId : INT -> Int32
# uFlags : SHCNF_FLAGS -> UInt32
# dwItem1 : void* optional -> Ptr{Cvoid}
# dwItem2 : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void SHChangeNotify(
    int32_t wEventId,
    uint32_t uFlags,
    void* dwItem1,
    void* dwItem2);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2)
-- wEventId : INT
-- uFlags : SHCNF_FLAGS
-- dwItem1 : void* optional
-- dwItem2 : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHChangeNotify = lib.func('__stdcall', 'SHChangeNotify', 'void', ['int32_t', 'uint32_t', 'void *', 'void *']);
// SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2)
// wEventId : INT -> 'int32_t'
// uFlags : SHCNF_FLAGS -> 'uint32_t'
// dwItem1 : void* optional -> 'void *'
// dwItem2 : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHChangeNotify: { parameters: ["i32", "u32", "pointer", "pointer"], result: "void" },
});
// lib.symbols.SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2)
// wEventId : INT -> "i32"
// uFlags : SHCNF_FLAGS -> "u32"
// dwItem1 : void* optional -> "pointer"
// dwItem2 : void* optional -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void SHChangeNotify(
    int32_t wEventId,
    uint32_t uFlags,
    void* dwItem1,
    void* dwItem2);
C, "SHELL32.dll");
// $ffi->SHChangeNotify(wEventId, uFlags, dwItem1, dwItem2);
// wEventId : INT
// uFlags : SHCNF_FLAGS
// dwItem1 : void* optional
// dwItem2 : void* optional
// 構造体/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);
    void SHChangeNotify(
        int wEventId,   // INT
        int uFlags,   // SHCNF_FLAGS
        Pointer dwItem1,   // void* optional
        Pointer dwItem2   // void* optional
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHChangeNotify = SHChangeNotify(
    wEventId : Int32,   # INT
    uFlags : UInt32,   # SHCNF_FLAGS
    dwItem1 : Void*,   # void* optional
    dwItem2 : Void*   # void* optional
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHChangeNotifyNative = Void Function(Int32, Uint32, Pointer<Void>, Pointer<Void>);
typedef SHChangeNotifyDart = void Function(int, int, Pointer<Void>, Pointer<Void>);
final SHChangeNotify = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHChangeNotifyNative, SHChangeNotifyDart>('SHChangeNotify');
// wEventId : INT -> Int32
// uFlags : SHCNF_FLAGS -> Uint32
// dwItem1 : void* optional -> Pointer<Void>
// dwItem2 : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure SHChangeNotify(
  wEventId: Integer;   // INT
  uFlags: DWORD;   // SHCNF_FLAGS
  dwItem1: Pointer;   // void* optional
  dwItem2: Pointer   // void* optional
); stdcall;
  external 'SHELL32.dll' name 'SHChangeNotify';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHChangeNotify"
  c_SHChangeNotify :: Int32 -> Word32 -> Ptr () -> Ptr () -> IO ()
-- wEventId : INT -> Int32
-- uFlags : SHCNF_FLAGS -> Word32
-- dwItem1 : void* optional -> Ptr ()
-- dwItem2 : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shchangenotify =
  foreign "SHChangeNotify"
    (int32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> returning void)
(* wEventId : INT -> int32_t *)
(* uFlags : SHCNF_FLAGS -> uint32_t *)
(* dwItem1 : void* optional -> (ptr void) *)
(* dwItem2 : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHChangeNotify" shchange-notify :convention :stdcall) :void
  (w-event-id :int32)   ; INT
  (u-flags :uint32)   ; SHCNF_FLAGS
  (dw-item1 :pointer)   ; void* optional
  (dw-item2 :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHChangeNotify = Win32::API::More->new('SHELL32',
    'void SHChangeNotify(int wEventId, DWORD uFlags, LPVOID dwItem1, LPVOID dwItem2)');
# my $ret = $SHChangeNotify->Call($wEventId, $uFlags, $dwItem1, $dwItem2);
# wEventId : INT -> int
# uFlags : SHCNF_FLAGS -> DWORD
# dwItem1 : void* optional -> LPVOID
# dwItem2 : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型