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

SHUpdateImageW

関数
システムイメージリスト内のアイコン(Unicode)を更新する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

void SHUpdateImageW(
    LPCWSTR pszHashItem,
    INT iIndex,
    DWORD uFlags,
    INT iImageIndex
);

パラメーター

名前方向説明
pszHashItemLPCWSTRinアイコンを含むファイルの完全修飾パスを指定する文字列値へのポインターです。IExtractIcon::GetIconLocationszIconFile パラメーターが指すバッファーに返されたパスを使用してください。
iIndexINTinpszHashItem で指定されたファイル内におけるアイコンの 0 から始まるインデックスを指定する整数です。IExtractIcon::GetIconLocationpiIndex パラメーターが指す値を使用してください。
uFlagsDWORDinアイコンの属性を決定するフラグを指定する符号なし整数です。uFlags には、IExtractIcon::GetIconLocationpwFlags パラメーターが指す値を設定してください。SHUpdateImage に関連するフラグは GIL_NOTFILENAMEGIL_SIMULATEDOC です。
iImageIndexINTin更新対象のアイコンの、システムイメージリスト内におけるインデックスを指定する整数です。

戻り値の型: void

公式ドキュメント

システムイメージリスト内のイメージが変更されたことをシェルに通知します。(Unicode)

解説(Remarks)

更新したいアイコンのシステムイメージリスト内のインデックスが分からない場合は、SHGetFileInfo を使用し、uFlags パラメーターに SHGFI_SYSICONINDEX を設定してください。

IExtractIcon::GetIconLocation には、置き換える新しいアイコンのパラメーターではなく、更新が必要な古いアイコンのパラメーターを指定する必要があります。

メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHUpdateImage を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不整合が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

void SHUpdateImageW(
    LPCWSTR pszHashItem,
    INT iIndex,
    DWORD uFlags,
    INT iImageIndex
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern void SHUpdateImageW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszHashItem,   // LPCWSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    int iImageIndex   // INT
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Sub SHUpdateImageW(
    <MarshalAs(UnmanagedType.LPWStr)> pszHashItem As String,   ' LPCWSTR
    iIndex As Integer,   ' INT
    uFlags As UInteger,   ' DWORD
    iImageIndex As Integer   ' INT
)
End Sub
' pszHashItem : LPCWSTR
' iIndex : INT
' uFlags : DWORD
' iImageIndex : INT
Declare PtrSafe Sub SHUpdateImageW Lib "shell32" ( _
    ByVal pszHashItem As LongPtr, _
    ByVal iIndex As Long, _
    ByVal uFlags As Long, _
    ByVal iImageIndex 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

SHUpdateImageW = ctypes.windll.shell32.SHUpdateImageW
SHUpdateImageW.restype = None
SHUpdateImageW.argtypes = [
    wintypes.LPCWSTR,  # pszHashItem : LPCWSTR
    ctypes.c_int,  # iIndex : INT
    wintypes.DWORD,  # uFlags : DWORD
    ctypes.c_int,  # iImageIndex : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHUpdateImageW = Fiddle::Function.new(
  lib['SHUpdateImageW'],
  [
    Fiddle::TYPE_VOIDP,  # pszHashItem : LPCWSTR
    Fiddle::TYPE_INT,  # iIndex : INT
    -Fiddle::TYPE_INT,  # uFlags : DWORD
    Fiddle::TYPE_INT,  # iImageIndex : INT
  ],
  Fiddle::TYPE_VOID)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHUpdateImageW(
        pszHashItem: *const u16,  // LPCWSTR
        iIndex: i32,  // INT
        uFlags: u32,  // DWORD
        iImageIndex: i32  // INT
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern void SHUpdateImageW([MarshalAs(UnmanagedType.LPWStr)] string pszHashItem, int iIndex, uint uFlags, int iImageIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHUpdateImageW' -Namespace Win32 -PassThru
# $api::SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex)
#uselib "SHELL32.dll"
#func global SHUpdateImageW "SHUpdateImageW" wptr, wptr, wptr, wptr
; SHUpdateImageW pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCWSTR -> "wptr"
; iIndex : INT -> "wptr"
; uFlags : DWORD -> "wptr"
; iImageIndex : INT -> "wptr"
#uselib "SHELL32.dll"
#func global SHUpdateImageW "SHUpdateImageW" wstr, int, int, int
; SHUpdateImageW pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCWSTR -> "wstr"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; iImageIndex : INT -> "int"
; void SHUpdateImageW(LPCWSTR pszHashItem, INT iIndex, DWORD uFlags, INT iImageIndex)
#uselib "SHELL32.dll"
#func global SHUpdateImageW "SHUpdateImageW" wstr, int, int, int
; SHUpdateImageW pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCWSTR -> "wstr"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; iImageIndex : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHUpdateImageW = shell32.NewProc("SHUpdateImageW")
)

// pszHashItem (LPCWSTR), iIndex (INT), uFlags (DWORD), iImageIndex (INT)
r1, _, err := procSHUpdateImageW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszHashItem))),
	uintptr(iIndex),
	uintptr(uFlags),
	uintptr(iImageIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure SHUpdateImageW(
  pszHashItem: PWideChar;   // LPCWSTR
  iIndex: Integer;   // INT
  uFlags: DWORD;   // DWORD
  iImageIndex: Integer   // INT
); stdcall;
  external 'SHELL32.dll' name 'SHUpdateImageW';
result := DllCall("SHELL32\SHUpdateImageW"
    , "WStr", pszHashItem   ; LPCWSTR
    , "Int", iIndex   ; INT
    , "UInt", uFlags   ; DWORD
    , "Int", iImageIndex   ; INT
    , "Int")   ; return: void
●SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex) = DLL("SHELL32.dll", "int SHUpdateImageW(char*, int, dword, int)")
# 呼び出し: SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex)
# pszHashItem : LPCWSTR -> "char*"
# iIndex : INT -> "int"
# uFlags : DWORD -> "dword"
# iImageIndex : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHUpdateImageW(
    pszHashItem: [*c]const u16, // LPCWSTR
    iIndex: i32, // INT
    uFlags: u32, // DWORD
    iImageIndex: i32 // INT
) callconv(std.os.windows.WINAPI) void;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHUpdateImageW(
    pszHashItem: WideCString,  # LPCWSTR
    iIndex: int32,  # INT
    uFlags: uint32,  # DWORD
    iImageIndex: int32  # INT
) {.importc: "SHUpdateImageW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
void SHUpdateImageW(
    const(wchar)* pszHashItem,   // LPCWSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    int iImageIndex   // INT
);
ccall((:SHUpdateImageW, "SHELL32.dll"), stdcall, Cvoid,
      (Cwstring, Int32, UInt32, Int32),
      pszHashItem, iIndex, uFlags, iImageIndex)
# pszHashItem : LPCWSTR -> Cwstring
# iIndex : INT -> Int32
# uFlags : DWORD -> UInt32
# iImageIndex : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void SHUpdateImageW(
    const uint16_t* pszHashItem,
    int32_t iIndex,
    uint32_t uFlags,
    int32_t iImageIndex);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex)
-- pszHashItem : LPCWSTR
-- iIndex : INT
-- uFlags : DWORD
-- iImageIndex : INT
-- 構造体/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 SHUpdateImageW = lib.func('__stdcall', 'SHUpdateImageW', 'void', ['str16', 'int32_t', 'uint32_t', 'int32_t']);
// SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex)
// pszHashItem : LPCWSTR -> 'str16'
// iIndex : INT -> 'int32_t'
// uFlags : DWORD -> 'uint32_t'
// iImageIndex : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHUpdateImageW: { parameters: ["buffer", "i32", "u32", "i32"], result: "void" },
});
// lib.symbols.SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex)
// pszHashItem : LPCWSTR -> "buffer"
// iIndex : INT -> "i32"
// uFlags : DWORD -> "u32"
// iImageIndex : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void SHUpdateImageW(
    const uint16_t* pszHashItem,
    int32_t iIndex,
    uint32_t uFlags,
    int32_t iImageIndex);
C, "SHELL32.dll");
// $ffi->SHUpdateImageW(pszHashItem, iIndex, uFlags, iImageIndex);
// pszHashItem : LPCWSTR
// iIndex : INT
// uFlags : DWORD
// iImageIndex : INT
// 構造体/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);
    void SHUpdateImageW(
        WString pszHashItem,   // LPCWSTR
        int iIndex,   // INT
        int uFlags,   // DWORD
        int iImageIndex   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHUpdateImageW = SHUpdateImageW(
    pszHashItem : UInt16*,   # LPCWSTR
    iIndex : Int32,   # INT
    uFlags : UInt32,   # DWORD
    iImageIndex : Int32   # INT
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHUpdateImageWNative = Void Function(Pointer<Utf16>, Int32, Uint32, Int32);
typedef SHUpdateImageWDart = void Function(Pointer<Utf16>, int, int, int);
final SHUpdateImageW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHUpdateImageWNative, SHUpdateImageWDart>('SHUpdateImageW');
// pszHashItem : LPCWSTR -> Pointer<Utf16>
// iIndex : INT -> Int32
// uFlags : DWORD -> Uint32
// iImageIndex : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure SHUpdateImageW(
  pszHashItem: PWideChar;   // LPCWSTR
  iIndex: Integer;   // INT
  uFlags: DWORD;   // DWORD
  iImageIndex: Integer   // INT
); stdcall;
  external 'SHELL32.dll' name 'SHUpdateImageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHUpdateImageW"
  c_SHUpdateImageW :: CWString -> Int32 -> Word32 -> Int32 -> IO ()
-- pszHashItem : LPCWSTR -> CWString
-- iIndex : INT -> Int32
-- uFlags : DWORD -> Word32
-- iImageIndex : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shupdateimagew =
  foreign "SHUpdateImageW"
    ((ptr uint16_t) @-> int32_t @-> uint32_t @-> int32_t @-> returning void)
(* pszHashItem : LPCWSTR -> (ptr uint16_t) *)
(* iIndex : INT -> int32_t *)
(* uFlags : DWORD -> uint32_t *)
(* iImageIndex : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHUpdateImageW" shupdate-image-w :convention :stdcall) :void
  (psz-hash-item (:string :encoding :utf-16le))   ; LPCWSTR
  (i-index :int32)   ; INT
  (u-flags :uint32)   ; DWORD
  (i-image-index :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHUpdateImageW = Win32::API::More->new('SHELL32',
    'void SHUpdateImageW(LPCWSTR pszHashItem, int iIndex, DWORD uFlags, int iImageIndex)');
# my $ret = $SHUpdateImageW->Call($pszHashItem, $iIndex, $uFlags, $iImageIndex);
# pszHashItem : LPCWSTR -> LPCWSTR
# iIndex : INT -> int
# uFlags : DWORD -> DWORD
# iImageIndex : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目