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

SHUpdateImageA

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

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

void SHUpdateImageA(
    LPCSTR pszHashItem,
    INT iIndex,
    DWORD uFlags,
    INT iImageIndex
);

パラメーター

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

戻り値の型: void

公式ドキュメント

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

解説(Remarks)

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

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

メモ

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

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

void SHUpdateImageA(
    LPCSTR pszHashItem,
    INT iIndex,
    DWORD uFlags,
    INT iImageIndex
);
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern void SHUpdateImageA(
    [MarshalAs(UnmanagedType.LPStr)] string pszHashItem,   // LPCSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    int iImageIndex   // INT
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Sub SHUpdateImageA(
    <MarshalAs(UnmanagedType.LPStr)> pszHashItem As String,   ' LPCSTR
    iIndex As Integer,   ' INT
    uFlags As UInteger,   ' DWORD
    iImageIndex As Integer   ' INT
)
End Sub
' pszHashItem : LPCSTR
' iIndex : INT
' uFlags : DWORD
' iImageIndex : INT
Declare PtrSafe Sub SHUpdateImageA Lib "shell32" ( _
    ByVal pszHashItem As String, _
    ByVal iIndex As Long, _
    ByVal uFlags As Long, _
    ByVal iImageIndex As Long)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('SHELL32.dll')
SHUpdateImageA = Fiddle::Function.new(
  lib['SHUpdateImageA'],
  [
    Fiddle::TYPE_VOIDP,  # pszHashItem : LPCSTR
    Fiddle::TYPE_INT,  # iIndex : INT
    -Fiddle::TYPE_INT,  # uFlags : DWORD
    Fiddle::TYPE_INT,  # iImageIndex : INT
  ],
  Fiddle::TYPE_VOID)
#[link(name = "shell32")]
extern "system" {
    fn SHUpdateImageA(
        pszHashItem: *const u8,  // LPCSTR
        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.Ansi)]
public static extern void SHUpdateImageA([MarshalAs(UnmanagedType.LPStr)] string pszHashItem, int iIndex, uint uFlags, int iImageIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHUpdateImageA' -Namespace Win32 -PassThru
# $api::SHUpdateImageA(pszHashItem, iIndex, uFlags, iImageIndex)
#uselib "SHELL32.dll"
#func global SHUpdateImageA "SHUpdateImageA" sptr, sptr, sptr, sptr
; SHUpdateImageA pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCSTR -> "sptr"
; iIndex : INT -> "sptr"
; uFlags : DWORD -> "sptr"
; iImageIndex : INT -> "sptr"
#uselib "SHELL32.dll"
#func global SHUpdateImageA "SHUpdateImageA" str, int, int, int
; SHUpdateImageA pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCSTR -> "str"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; iImageIndex : INT -> "int"
; void SHUpdateImageA(LPCSTR pszHashItem, INT iIndex, DWORD uFlags, INT iImageIndex)
#uselib "SHELL32.dll"
#func global SHUpdateImageA "SHUpdateImageA" str, int, int, int
; SHUpdateImageA pszHashItem, iIndex, uFlags, iImageIndex
; pszHashItem : LPCSTR -> "str"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; iImageIndex : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHUpdateImageA = shell32.NewProc("SHUpdateImageA")
)

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

extern "shell32" fn SHUpdateImageA(
    pszHashItem: [*c]const u8, // LPCSTR
    iIndex: i32, // INT
    uFlags: u32, // DWORD
    iImageIndex: i32 // INT
) callconv(std.os.windows.WINAPI) void;
proc SHUpdateImageA(
    pszHashItem: cstring,  # LPCSTR
    iIndex: int32,  # INT
    uFlags: uint32,  # DWORD
    iImageIndex: int32  # INT
) {.importc: "SHUpdateImageA", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
void SHUpdateImageA(
    const(char)* pszHashItem,   // LPCSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    int iImageIndex   // INT
);
ccall((:SHUpdateImageA, "SHELL32.dll"), stdcall, Cvoid,
      (Cstring, Int32, UInt32, Int32),
      pszHashItem, iIndex, uFlags, iImageIndex)
# pszHashItem : LPCSTR -> Cstring
# iIndex : INT -> Int32
# uFlags : DWORD -> UInt32
# iImageIndex : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void SHUpdateImageA(
    const char* pszHashItem,
    int32_t iIndex,
    uint32_t uFlags,
    int32_t iImageIndex);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHUpdateImageA(pszHashItem, iIndex, uFlags, iImageIndex)
-- pszHashItem : LPCSTR
-- iIndex : INT
-- uFlags : DWORD
-- iImageIndex : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHUpdateImageA = lib.func('__stdcall', 'SHUpdateImageA', 'void', ['str', 'int32_t', 'uint32_t', 'int32_t']);
// SHUpdateImageA(pszHashItem, iIndex, uFlags, iImageIndex)
// pszHashItem : LPCSTR -> 'str'
// iIndex : INT -> 'int32_t'
// uFlags : DWORD -> 'uint32_t'
// iImageIndex : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHUpdateImageA: { parameters: ["buffer", "i32", "u32", "i32"], result: "void" },
});
// lib.symbols.SHUpdateImageA(pszHashItem, iIndex, uFlags, iImageIndex)
// pszHashItem : LPCSTR -> "buffer"
// iIndex : INT -> "i32"
// uFlags : DWORD -> "u32"
// iImageIndex : INT -> "i32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void SHUpdateImageA(
    const char* pszHashItem,
    int32_t iIndex,
    uint32_t uFlags,
    int32_t iImageIndex);
C, "SHELL32.dll");
// $ffi->SHUpdateImageA(pszHashItem, iIndex, uFlags, iImageIndex);
// pszHashItem : LPCSTR
// 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.ASCII_OPTIONS);
    void SHUpdateImageA(
        String pszHashItem,   // LPCSTR
        int iIndex,   // INT
        int uFlags,   // DWORD
        int iImageIndex   // INT
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun SHUpdateImageA = SHUpdateImageA(
    pszHashItem : UInt8*,   # LPCSTR
    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 SHUpdateImageANative = Void Function(Pointer<Utf8>, Int32, Uint32, Int32);
typedef SHUpdateImageADart = void Function(Pointer<Utf8>, int, int, int);
final SHUpdateImageA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHUpdateImageANative, SHUpdateImageADart>('SHUpdateImageA');
// pszHashItem : LPCSTR -> Pointer<Utf8>
// iIndex : INT -> Int32
// uFlags : DWORD -> Uint32
// iImageIndex : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure SHUpdateImageA(
  pszHashItem: PAnsiChar;   // LPCSTR
  iIndex: Integer;   // INT
  uFlags: DWORD;   // DWORD
  iImageIndex: Integer   // INT
); stdcall;
  external 'SHELL32.dll' name 'SHUpdateImageA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let shupdateimagea =
  foreign "SHUpdateImageA"
    (string @-> int32_t @-> uint32_t @-> int32_t @-> returning void)
(* pszHashItem : LPCSTR -> string *)
(* 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 ("SHUpdateImageA" shupdate-image-a :convention :stdcall) :void
  (psz-hash-item :string)   ; LPCSTR
  (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 $SHUpdateImageA = Win32::API::More->new('SHELL32',
    'void SHUpdateImageA(LPCSTR pszHashItem, int iIndex, DWORD uFlags, int iImageIndex)');
# my $ret = $SHUpdateImageA->Call($pszHashItem, $iIndex, $uFlags, $iImageIndex);
# pszHashItem : LPCSTR -> LPCSTR
# iIndex : INT -> int
# uFlags : DWORD -> DWORD
# iImageIndex : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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