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

ImageList_Add

関数
ビットマップとマスクをイメージリストに追加する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

INT ImageList_Add(
    HIMAGELIST himl,
    HBITMAP hbmImage,
    HBITMAP hbmMask   // optional
);

パラメーター

名前方向説明
himlHIMAGELISTinイメージリストへのハンドルです。
hbmImageHBITMAPinイメージを含むビットマップへのハンドルです。イメージの数はビットマップの幅から推測されます。
hbmMaskHBITMAPinoptionalマスクを含むビットマップへのハンドルです。イメージリストでマスクを使用しない場合、このパラメーターは無視されます。このパラメーターには NULL を指定できます。

戻り値の型: INT

公式ドキュメント

イメージリストに1つまたは複数のイメージを追加します。(ImageList_Add)

戻り値

型: int

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

解説(Remarks)

ImageList_Add 関数は、ビットマップを内部のデータ構造にコピーします。関数から戻った後は、DeleteObject 関数を使用して hbmImagehbmMask を必ず削除してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_Add(
    HIMAGELIST himl,
    HBITMAP hbmImage,
    HBITMAP hbmMask   // optional
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int ImageList_Add(
    IntPtr himl,   // HIMAGELIST
    IntPtr hbmImage,   // HBITMAP
    IntPtr hbmMask   // HBITMAP optional
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function ImageList_Add(
    himl As IntPtr,   ' HIMAGELIST
    hbmImage As IntPtr,   ' HBITMAP
    hbmMask As IntPtr   ' HBITMAP optional
) As Integer
End Function
' himl : HIMAGELIST
' hbmImage : HBITMAP
' hbmMask : HBITMAP optional
Declare PtrSafe Function ImageList_Add Lib "comctl32" ( _
    ByVal himl As LongPtr, _
    ByVal hbmImage As LongPtr, _
    ByVal hbmMask As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ImageList_Add = ctypes.windll.comctl32.ImageList_Add
ImageList_Add.restype = ctypes.c_int
ImageList_Add.argtypes = [
    ctypes.c_ssize_t,  # himl : HIMAGELIST
    wintypes.HANDLE,  # hbmImage : HBITMAP
    wintypes.HANDLE,  # hbmMask : HBITMAP optional
]
require 'fiddle'
require 'fiddle/import'

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procImageList_Add = comctl32.NewProc("ImageList_Add")
)

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

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

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

foreign import stdcall safe "ImageList_Add"
  c_ImageList_Add :: CIntPtr -> Ptr () -> Ptr () -> IO Int32
-- himl : HIMAGELIST -> CIntPtr
-- hbmImage : HBITMAP -> Ptr ()
-- hbmMask : HBITMAP optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagelist_add =
  foreign "ImageList_Add"
    (intptr_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* himl : HIMAGELIST -> intptr_t *)
(* hbmImage : HBITMAP -> (ptr void) *)
(* hbmMask : HBITMAP optional -> (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_Add" image-list-add :convention :stdcall) :int32
  (himl :int64)   ; HIMAGELIST
  (hbm-image :pointer)   ; HBITMAP
  (hbm-mask :pointer))   ; HBITMAP optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageList_Add = Win32::API::More->new('COMCTL32',
    'int ImageList_Add(LPARAM himl, HANDLE hbmImage, HANDLE hbmMask)');
# my $ret = $ImageList_Add->Call($himl, $hbmImage, $hbmMask);
# himl : HIMAGELIST -> LPARAM
# hbmImage : HBITMAP -> HANDLE
# hbmMask : HBITMAP optional -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。