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

ImageList_ReplaceIcon

関数
イメージリスト内の画像をアイコンで置換または追加する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT ImageList_ReplaceIcon(
    HIMAGELIST himl,
    INT i,
    HICON hicon
);

パラメーター

名前方向説明
himlHIMAGELISTinイメージリストへのハンドル。
iINTin置き換えるイメージのインデックス。 i が -1 の場合、この関数はイメージをリストの末尾に追加します。
hiconHICONin新しいイメージのビットマップとマスクを含むアイコンまたはカーソルへのハンドル。

戻り値の型: INT

公式ドキュメント

イメージをアイコンまたはカーソルで置き換えます。(ImageList_ReplaceIcon)

戻り値

型: int

成功した場合はイメージのインデックスを返し、それ以外の場合は -1 を返します。

解説(Remarks)

システムは hicon を保存しないため、アイコンまたはカーソルが CreateIcon 関数によって作成された場合は、関数が返った後に破棄できます。LoadIcon 関数によって読み込まれた場合は、hicon を破棄する必要はありません。アイコンリソースが不要になると、システムが自動的に解放します。

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

各言語での呼び出し定義

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

INT ImageList_ReplaceIcon(
    HIMAGELIST himl,
    INT i,
    HICON hicon
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int ImageList_ReplaceIcon(
    IntPtr himl,   // HIMAGELIST
    int i,   // INT
    IntPtr hicon   // HICON
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function ImageList_ReplaceIcon(
    himl As IntPtr,   ' HIMAGELIST
    i As Integer,   ' INT
    hicon As IntPtr   ' HICON
) As Integer
End Function
' himl : HIMAGELIST
' i : INT
' hicon : HICON
Declare PtrSafe Function ImageList_ReplaceIcon Lib "comctl32" ( _
    ByVal himl As LongPtr, _
    ByVal i As Long, _
    ByVal hicon As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImageList_ReplaceIcon = ctypes.windll.comctl32.ImageList_ReplaceIcon
ImageList_ReplaceIcon.restype = ctypes.c_int
ImageList_ReplaceIcon.argtypes = [
    ctypes.c_ssize_t,  # himl : HIMAGELIST
    ctypes.c_int,  # i : INT
    wintypes.HANDLE,  # hicon : HICON
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
ImageList_ReplaceIcon = Fiddle::Function.new(
  lib['ImageList_ReplaceIcon'],
  [
    Fiddle::TYPE_INTPTR_T,  # himl : HIMAGELIST
    Fiddle::TYPE_INT,  # i : INT
    Fiddle::TYPE_VOIDP,  # hicon : HICON
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn ImageList_ReplaceIcon(
        himl: isize,  // HIMAGELIST
        i: i32,  // INT
        hicon: *mut core::ffi::c_void  // HICON
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int ImageList_ReplaceIcon(IntPtr himl, int i, IntPtr hicon);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_ImageList_ReplaceIcon' -Namespace Win32 -PassThru
# $api::ImageList_ReplaceIcon(himl, i, hicon)
#uselib "COMCTL32.dll"
#func global ImageList_ReplaceIcon "ImageList_ReplaceIcon" sptr, sptr, sptr
; ImageList_ReplaceIcon himl, i, hicon   ; 戻り値は stat
; himl : HIMAGELIST -> "sptr"
; i : INT -> "sptr"
; hicon : HICON -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global ImageList_ReplaceIcon "ImageList_ReplaceIcon" sptr, int, sptr
; res = ImageList_ReplaceIcon(himl, i, hicon)
; himl : HIMAGELIST -> "sptr"
; i : INT -> "int"
; hicon : HICON -> "sptr"
; INT ImageList_ReplaceIcon(HIMAGELIST himl, INT i, HICON hicon)
#uselib "COMCTL32.dll"
#cfunc global ImageList_ReplaceIcon "ImageList_ReplaceIcon" intptr, int, intptr
; res = ImageList_ReplaceIcon(himl, i, hicon)
; himl : HIMAGELIST -> "intptr"
; i : INT -> "int"
; hicon : HICON -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procImageList_ReplaceIcon = comctl32.NewProc("ImageList_ReplaceIcon")
)

// himl (HIMAGELIST), i (INT), hicon (HICON)
r1, _, err := procImageList_ReplaceIcon.Call(
	uintptr(himl),
	uintptr(i),
	uintptr(hicon),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function ImageList_ReplaceIcon(
  himl: NativeInt;   // HIMAGELIST
  i: Integer;   // INT
  hicon: THandle   // HICON
): Integer; stdcall;
  external 'COMCTL32.dll' name 'ImageList_ReplaceIcon';
result := DllCall("COMCTL32\ImageList_ReplaceIcon"
    , "Ptr", himl   ; HIMAGELIST
    , "Int", i   ; INT
    , "Ptr", hicon   ; HICON
    , "Int")   ; return: INT
●ImageList_ReplaceIcon(himl, i, hicon) = DLL("COMCTL32.dll", "int ImageList_ReplaceIcon(int, int, void*)")
# 呼び出し: ImageList_ReplaceIcon(himl, i, hicon)
# himl : HIMAGELIST -> "int"
# i : INT -> "int"
# hicon : HICON -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef ImageList_ReplaceIconNative = Int32 Function(IntPtr, Int32, Pointer<Void>);
typedef ImageList_ReplaceIconDart = int Function(int, int, Pointer<Void>);
final ImageList_ReplaceIcon = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<ImageList_ReplaceIconNative, ImageList_ReplaceIconDart>('ImageList_ReplaceIcon');
// himl : HIMAGELIST -> IntPtr
// i : INT -> Int32
// hicon : HICON -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImageList_ReplaceIcon(
  himl: NativeInt;   // HIMAGELIST
  i: Integer;   // INT
  hicon: THandle   // HICON
): Integer; stdcall;
  external 'COMCTL32.dll' name 'ImageList_ReplaceIcon';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImageList_ReplaceIcon"
  c_ImageList_ReplaceIcon :: CIntPtr -> Int32 -> Ptr () -> IO Int32
-- himl : HIMAGELIST -> CIntPtr
-- i : INT -> Int32
-- hicon : HICON -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagelist_replaceicon =
  foreign "ImageList_ReplaceIcon"
    (intptr_t @-> int32_t @-> (ptr void) @-> returning int32_t)
(* himl : HIMAGELIST -> intptr_t *)
(* i : INT -> int32_t *)
(* hicon : HICON -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("ImageList_ReplaceIcon" image-list-replace-icon :convention :stdcall) :int32
  (himl :int64)   ; HIMAGELIST
  (i :int32)   ; INT
  (hicon :pointer))   ; HICON
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageList_ReplaceIcon = Win32::API::More->new('COMCTL32',
    'int ImageList_ReplaceIcon(LPARAM himl, int i, HANDLE hicon)');
# my $ret = $ImageList_ReplaceIcon->Call($himl, $i, $hicon);
# himl : HIMAGELIST -> LPARAM
# i : INT -> int
# hicon : HICON -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。