SHHandleUpdateImage
関数システムイメージリストの更新イベントを処理する。
シグネチャ
// SHELL32.dll
#include <windows.h>
INT SHHandleUpdateImage(
ITEMIDLIST* pidlExtra
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| pidlExtra | ITEMIDLIST* | in | 変更されたシステム イメージ リスト内のインデックス。IShellChangeNotify::OnChange の pidl2 パラメーターで指定されます。 |
戻り値の型: INT
公式ドキュメント
SHHandleUpdateImage は変更されるか、利用できなくなる可能性があります。
戻り値
型: int
失敗した場合は -1 を返し、成功した場合は変更されたイメージ リスト エントリのインデックスを返します。
解説(Remarks)
SHHandleUpdateImage は、変更通知コールバックで受け取った pidl2 パラメーターが非 NULL の場合にのみ使用してください。
例
次の例は、IShellChangeNotify::OnChange の実装における SHHandleUpdateImage の使用方法を示しています。
STDMETHODIMP CMyShellChangeNotify::OnChange(LONG lEvent,
LPCITEMIDLIST pidl1,
LPCITEMIDLIST pidl2)
{
HRESULT hr = E_FAIL;
int iImage;
switch(lEvent)
{
// An image in the system image list has changed.
case SHCNE_UPDATEIMAGE:
{
hr = S_OK;
if (pidl2)
iImage = SHHandleUpdateImage(pidl2);
else
iImage = *(int UNALIGNED *)((BYTE *)pidl1 + 2);
if (iImage != -1)
{
// Process iImage as desired.
}
break;
}
// Other cases
}
return hr;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHELL32.dll
#include <windows.h>
INT SHHandleUpdateImage(
ITEMIDLIST* pidlExtra
);[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHHandleUpdateImage(
IntPtr pidlExtra // ITEMIDLIST*
);<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHHandleUpdateImage(
pidlExtra As IntPtr ' ITEMIDLIST*
) As Integer
End Function' pidlExtra : ITEMIDLIST*
Declare PtrSafe Function SHHandleUpdateImage Lib "shell32" ( _
ByVal pidlExtra As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SHHandleUpdateImage = ctypes.windll.shell32.SHHandleUpdateImage
SHHandleUpdateImage.restype = ctypes.c_int
SHHandleUpdateImage.argtypes = [
ctypes.c_void_p, # pidlExtra : ITEMIDLIST*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHELL32.dll')
SHHandleUpdateImage = Fiddle::Function.new(
lib['SHHandleUpdateImage'],
[
Fiddle::TYPE_VOIDP, # pidlExtra : ITEMIDLIST*
],
Fiddle::TYPE_INT)#[link(name = "shell32")]
extern "system" {
fn SHHandleUpdateImage(
pidlExtra: *mut ITEMIDLIST // ITEMIDLIST*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHHandleUpdateImage(IntPtr pidlExtra);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHHandleUpdateImage' -Namespace Win32 -PassThru
# $api::SHHandleUpdateImage(pidlExtra)#uselib "SHELL32.dll"
#func global SHHandleUpdateImage "SHHandleUpdateImage" sptr
; SHHandleUpdateImage varptr(pidlExtra) ; 戻り値は stat
; pidlExtra : ITEMIDLIST* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHELL32.dll" #cfunc global SHHandleUpdateImage "SHHandleUpdateImage" var ; res = SHHandleUpdateImage(pidlExtra) ; pidlExtra : ITEMIDLIST* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll" #cfunc global SHHandleUpdateImage "SHHandleUpdateImage" sptr ; res = SHHandleUpdateImage(varptr(pidlExtra)) ; pidlExtra : ITEMIDLIST* -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; INT SHHandleUpdateImage(ITEMIDLIST* pidlExtra) #uselib "SHELL32.dll" #cfunc global SHHandleUpdateImage "SHHandleUpdateImage" var ; res = SHHandleUpdateImage(pidlExtra) ; pidlExtra : ITEMIDLIST* -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; INT SHHandleUpdateImage(ITEMIDLIST* pidlExtra) #uselib "SHELL32.dll" #cfunc global SHHandleUpdateImage "SHHandleUpdateImage" intptr ; res = SHHandleUpdateImage(varptr(pidlExtra)) ; pidlExtra : ITEMIDLIST* -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shell32 = windows.NewLazySystemDLL("SHELL32.dll")
procSHHandleUpdateImage = shell32.NewProc("SHHandleUpdateImage")
)
// pidlExtra (ITEMIDLIST*)
r1, _, err := procSHHandleUpdateImage.Call(
uintptr(pidlExtra),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction SHHandleUpdateImage(
pidlExtra: Pointer // ITEMIDLIST*
): Integer; stdcall;
external 'SHELL32.dll' name 'SHHandleUpdateImage';result := DllCall("SHELL32\SHHandleUpdateImage"
, "Ptr", pidlExtra ; ITEMIDLIST*
, "Int") ; return: INT●SHHandleUpdateImage(pidlExtra) = DLL("SHELL32.dll", "int SHHandleUpdateImage(void*)")
# 呼び出し: SHHandleUpdateImage(pidlExtra)
# pidlExtra : ITEMIDLIST* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shell32" fn SHHandleUpdateImage(
pidlExtra: [*c]ITEMIDLIST // ITEMIDLIST*
) callconv(std.os.windows.WINAPI) i32;proc SHHandleUpdateImage(
pidlExtra: ptr ITEMIDLIST # ITEMIDLIST*
): int32 {.importc: "SHHandleUpdateImage", stdcall, dynlib: "SHELL32.dll".}pragma(lib, "shell32");
extern(Windows)
int SHHandleUpdateImage(
ITEMIDLIST* pidlExtra // ITEMIDLIST*
);ccall((:SHHandleUpdateImage, "SHELL32.dll"), stdcall, Int32,
(Ptr{ITEMIDLIST},),
pidlExtra)
# pidlExtra : ITEMIDLIST* -> Ptr{ITEMIDLIST}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SHHandleUpdateImage(
void* pidlExtra);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHHandleUpdateImage(pidlExtra)
-- pidlExtra : ITEMIDLIST*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHHandleUpdateImage = lib.func('__stdcall', 'SHHandleUpdateImage', 'int32_t', ['void *']);
// SHHandleUpdateImage(pidlExtra)
// pidlExtra : ITEMIDLIST* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHELL32.dll", {
SHHandleUpdateImage: { parameters: ["pointer"], result: "i32" },
});
// lib.symbols.SHHandleUpdateImage(pidlExtra)
// pidlExtra : ITEMIDLIST* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SHHandleUpdateImage(
void* pidlExtra);
C, "SHELL32.dll");
// $ffi->SHHandleUpdateImage(pidlExtra);
// pidlExtra : ITEMIDLIST*
// 構造体/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);
int SHHandleUpdateImage(
Pointer pidlExtra // ITEMIDLIST*
);
}@[Link("shell32")]
lib LibSHELL32
fun SHHandleUpdateImage = SHHandleUpdateImage(
pidlExtra : ITEMIDLIST* # ITEMIDLIST*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef SHHandleUpdateImageNative = Int32 Function(Pointer<Void>);
typedef SHHandleUpdateImageDart = int Function(Pointer<Void>);
final SHHandleUpdateImage = DynamicLibrary.open('SHELL32.dll')
.lookupFunction<SHHandleUpdateImageNative, SHHandleUpdateImageDart>('SHHandleUpdateImage');
// pidlExtra : ITEMIDLIST* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SHHandleUpdateImage(
pidlExtra: Pointer // ITEMIDLIST*
): Integer; stdcall;
external 'SHELL32.dll' name 'SHHandleUpdateImage';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SHHandleUpdateImage"
c_SHHandleUpdateImage :: Ptr () -> IO Int32
-- pidlExtra : ITEMIDLIST* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let shhandleupdateimage =
foreign "SHHandleUpdateImage"
((ptr void) @-> returning int32_t)
(* pidlExtra : ITEMIDLIST* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)
(cffi:defcfun ("SHHandleUpdateImage" shhandle-update-image :convention :stdcall) :int32
(pidl-extra :pointer)) ; ITEMIDLIST*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SHHandleUpdateImage = Win32::API::More->new('SHELL32',
'int SHHandleUpdateImage(LPVOID pidlExtra)');
# my $ret = $SHHandleUpdateImage->Call($pidlExtra);
# pidlExtra : ITEMIDLIST* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- i IShellChangeNotify
- f SHChangeNotify — シェルにファイルやフォルダーの変更イベントを通知する。
使用する型