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

SHChangeNotification_Lock

関数
シェル変更通知の共有メモリをロックし内容を取得する。
DLLSHELL32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HANDLE SHChangeNotification_Lock(
    HANDLE hChange,
    DWORD dwProcId,
    ITEMIDLIST*** pppidl,   // optional
    INT* plEvent   // optional
);

パラメーター

名前方向説明
hChangeHANDLEin指定された Shell の変更通知メッセージで wParam として受け取ったウィンドウへのハンドル。
dwProcIdDWORDinプロセス ID(メッセージ コールバックの lParam)。
pppidlITEMIDLIST***outoptionalPIDLIST_ABSOLUTE へのポインターのアドレス。この関数が正常に返ると、影響を受けた PIDL のリストを受け取ります。
plEventINT*outoptionalLONG 値へのポインター。この関数が正常に返ると、発生したイベントの Shell 変更通知 ID を受け取ります。

戻り値の型: HANDLE

公式ドキュメント

Shell の変更通知イベントに関連付けられた共有メモリをロックします。

戻り値

型: HANDLE

ロックされたメモリへのハンドル(HLOCK)を返します。処理が完了したら、この値を SHChangeNotification_Unlock に渡してください。

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

各言語での呼び出し定義

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

HANDLE SHChangeNotification_Lock(
    HANDLE hChange,
    DWORD dwProcId,
    ITEMIDLIST*** pppidl,   // optional
    INT* plEvent   // optional
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern IntPtr SHChangeNotification_Lock(
    IntPtr hChange,   // HANDLE
    uint dwProcId,   // DWORD
    IntPtr pppidl,   // ITEMIDLIST*** optional, out
    IntPtr plEvent   // INT* optional, out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHChangeNotification_Lock(
    hChange As IntPtr,   ' HANDLE
    dwProcId As UInteger,   ' DWORD
    pppidl As IntPtr,   ' ITEMIDLIST*** optional, out
    plEvent As IntPtr   ' INT* optional, out
) As IntPtr
End Function
' hChange : HANDLE
' dwProcId : DWORD
' pppidl : ITEMIDLIST*** optional, out
' plEvent : INT* optional, out
Declare PtrSafe Function SHChangeNotification_Lock Lib "shell32" ( _
    ByVal hChange As LongPtr, _
    ByVal dwProcId As Long, _
    ByVal pppidl As LongPtr, _
    ByVal plEvent As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHChangeNotification_Lock = ctypes.windll.shell32.SHChangeNotification_Lock
SHChangeNotification_Lock.restype = ctypes.c_void_p
SHChangeNotification_Lock.argtypes = [
    wintypes.HANDLE,  # hChange : HANDLE
    wintypes.DWORD,  # dwProcId : DWORD
    ctypes.c_void_p,  # pppidl : ITEMIDLIST*** optional, out
    ctypes.POINTER(ctypes.c_int),  # plEvent : INT* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHChangeNotification_Lock = Fiddle::Function.new(
  lib['SHChangeNotification_Lock'],
  [
    Fiddle::TYPE_VOIDP,  # hChange : HANDLE
    -Fiddle::TYPE_INT,  # dwProcId : DWORD
    Fiddle::TYPE_VOIDP,  # pppidl : ITEMIDLIST*** optional, out
    Fiddle::TYPE_VOIDP,  # plEvent : INT* optional, out
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "shell32")]
extern "system" {
    fn SHChangeNotification_Lock(
        hChange: *mut core::ffi::c_void,  // HANDLE
        dwProcId: u32,  // DWORD
        pppidl: *mut *mut *mut ITEMIDLIST,  // ITEMIDLIST*** optional, out
        plEvent: *mut i32  // INT* optional, out
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern IntPtr SHChangeNotification_Lock(IntPtr hChange, uint dwProcId, IntPtr pppidl, IntPtr plEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHChangeNotification_Lock' -Namespace Win32 -PassThru
# $api::SHChangeNotification_Lock(hChange, dwProcId, pppidl, plEvent)
#uselib "SHELL32.dll"
#func global SHChangeNotification_Lock "SHChangeNotification_Lock" sptr, sptr, sptr, sptr
; SHChangeNotification_Lock hChange, dwProcId, varptr(pppidl), varptr(plEvent)   ; 戻り値は stat
; hChange : HANDLE -> "sptr"
; dwProcId : DWORD -> "sptr"
; pppidl : ITEMIDLIST*** optional, out -> "sptr"
; plEvent : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHELL32.dll"
#cfunc global SHChangeNotification_Lock "SHChangeNotification_Lock" sptr, int, var, var
; res = SHChangeNotification_Lock(hChange, dwProcId, pppidl, plEvent)
; hChange : HANDLE -> "sptr"
; dwProcId : DWORD -> "int"
; pppidl : ITEMIDLIST*** optional, out -> "var"
; plEvent : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE SHChangeNotification_Lock(HANDLE hChange, DWORD dwProcId, ITEMIDLIST*** pppidl, INT* plEvent)
#uselib "SHELL32.dll"
#cfunc global SHChangeNotification_Lock "SHChangeNotification_Lock" intptr, int, var, var
; res = SHChangeNotification_Lock(hChange, dwProcId, pppidl, plEvent)
; hChange : HANDLE -> "intptr"
; dwProcId : DWORD -> "int"
; pppidl : ITEMIDLIST*** optional, out -> "var"
; plEvent : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHChangeNotification_Lock = shell32.NewProc("SHChangeNotification_Lock")
)

// hChange (HANDLE), dwProcId (DWORD), pppidl (ITEMIDLIST*** optional, out), plEvent (INT* optional, out)
r1, _, err := procSHChangeNotification_Lock.Call(
	uintptr(hChange),
	uintptr(dwProcId),
	uintptr(pppidl),
	uintptr(plEvent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function SHChangeNotification_Lock(
  hChange: THandle;   // HANDLE
  dwProcId: DWORD;   // DWORD
  pppidl: Pointer;   // ITEMIDLIST*** optional, out
  plEvent: Pointer   // INT* optional, out
): THandle; stdcall;
  external 'SHELL32.dll' name 'SHChangeNotification_Lock';
result := DllCall("SHELL32\SHChangeNotification_Lock"
    , "Ptr", hChange   ; HANDLE
    , "UInt", dwProcId   ; DWORD
    , "Ptr", pppidl   ; ITEMIDLIST*** optional, out
    , "Ptr", plEvent   ; INT* optional, out
    , "Ptr")   ; return: HANDLE
●SHChangeNotification_Lock(hChange, dwProcId, pppidl, plEvent) = DLL("SHELL32.dll", "void* SHChangeNotification_Lock(void*, dword, void*, void*)")
# 呼び出し: SHChangeNotification_Lock(hChange, dwProcId, pppidl, plEvent)
# hChange : HANDLE -> "void*"
# dwProcId : DWORD -> "dword"
# pppidl : ITEMIDLIST*** optional, out -> "void*"
# plEvent : INT* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHChangeNotification_LockNative = Pointer<Void> Function(Pointer<Void>, Uint32, Pointer<Void>, Pointer<Int32>);
typedef SHChangeNotification_LockDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Void>, Pointer<Int32>);
final SHChangeNotification_Lock = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHChangeNotification_LockNative, SHChangeNotification_LockDart>('SHChangeNotification_Lock');
// hChange : HANDLE -> Pointer<Void>
// dwProcId : DWORD -> Uint32
// pppidl : ITEMIDLIST*** optional, out -> Pointer<Void>
// plEvent : INT* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHChangeNotification_Lock(
  hChange: THandle;   // HANDLE
  dwProcId: DWORD;   // DWORD
  pppidl: Pointer;   // ITEMIDLIST*** optional, out
  plEvent: Pointer   // INT* optional, out
): THandle; stdcall;
  external 'SHELL32.dll' name 'SHChangeNotification_Lock';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHChangeNotification_Lock"
  c_SHChangeNotification_Lock :: Ptr () -> Word32 -> Ptr () -> Ptr Int32 -> IO (Ptr ())
-- hChange : HANDLE -> Ptr ()
-- dwProcId : DWORD -> Word32
-- pppidl : ITEMIDLIST*** optional, out -> Ptr ()
-- plEvent : INT* optional, out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shchangenotification_lock =
  foreign "SHChangeNotification_Lock"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> (ptr int32_t) @-> returning (ptr void))
(* hChange : HANDLE -> (ptr void) *)
(* dwProcId : DWORD -> uint32_t *)
(* pppidl : ITEMIDLIST*** optional, out -> (ptr void) *)
(* plEvent : INT* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHChangeNotification_Lock" shchange-notification-lock :convention :stdcall) :pointer
  (h-change :pointer)   ; HANDLE
  (dw-proc-id :uint32)   ; DWORD
  (pppidl :pointer)   ; ITEMIDLIST*** optional, out
  (pl-event :pointer))   ; INT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHChangeNotification_Lock = Win32::API::More->new('SHELL32',
    'HANDLE SHChangeNotification_Lock(HANDLE hChange, DWORD dwProcId, LPVOID pppidl, LPVOID plEvent)');
# my $ret = $SHChangeNotification_Lock->Call($hChange, $dwProcId, $pppidl, $plEvent);
# hChange : HANDLE -> HANDLE
# dwProcId : DWORD -> DWORD
# pppidl : ITEMIDLIST*** optional, out -> LPVOID
# plEvent : INT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型