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

ImageList_SetBkColor

関数
イメージリストの背景色を設定する。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

COLORREF ImageList_SetBkColor(
    HIMAGELIST himl,
    COLORREF clrBk
);

パラメーター

名前方向説明
himlHIMAGELISTinイメージリストへのハンドル。
clrBkCOLORREFin設定する背景色。このパラメーターには CLR_NONE 値を指定できます。その場合、画像はマスクを使用して透過的に描画されます。

戻り値の型: COLORREF

公式ドキュメント

イメージリストの背景色を設定します。この関数は、アイコンを追加するか、白黒ビットマップを指定して ImageList_AddMasked を使用した場合にのみ機能します。マスクがない場合は画像全体が描画されるため、背景色は表示されません。

戻り値

型: COLORREF

成功した場合は以前の背景色を返し、それ以外の場合は CLR_NONE を返します。

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

各言語での呼び出し定義

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

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

ImageList_SetBkColor = ctypes.windll.comctl32.ImageList_SetBkColor
ImageList_SetBkColor.restype = wintypes.DWORD
ImageList_SetBkColor.argtypes = [
    ctypes.c_ssize_t,  # himl : HIMAGELIST
    wintypes.DWORD,  # clrBk : COLORREF
]
require 'fiddle'
require 'fiddle/import'

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

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procImageList_SetBkColor = comctl32.NewProc("ImageList_SetBkColor")
)

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

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

typedef ImageList_SetBkColorNative = Uint32 Function(IntPtr, Uint32);
typedef ImageList_SetBkColorDart = int Function(int, int);
final ImageList_SetBkColor = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<ImageList_SetBkColorNative, ImageList_SetBkColorDart>('ImageList_SetBkColor');
// himl : HIMAGELIST -> IntPtr
// clrBk : COLORREF -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ImageList_SetBkColor(
  himl: NativeInt;   // HIMAGELIST
  clrBk: DWORD   // COLORREF
): DWORD; stdcall;
  external 'COMCTL32.dll' name 'ImageList_SetBkColor';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ImageList_SetBkColor"
  c_ImageList_SetBkColor :: CIntPtr -> Word32 -> IO Word32
-- himl : HIMAGELIST -> CIntPtr
-- clrBk : COLORREF -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let imagelist_setbkcolor =
  foreign "ImageList_SetBkColor"
    (intptr_t @-> uint32_t @-> returning uint32_t)
(* himl : HIMAGELIST -> intptr_t *)
(* clrBk : COLORREF -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("ImageList_SetBkColor" image-list-set-bk-color :convention :stdcall) :uint32
  (himl :int64)   ; HIMAGELIST
  (clr-bk :uint32))   ; COLORREF
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ImageList_SetBkColor = Win32::API::More->new('COMCTL32',
    'DWORD ImageList_SetBkColor(LPARAM himl, DWORD clrBk)');
# my $ret = $ImageList_SetBkColor->Call($himl, $clrBk);
# himl : HIMAGELIST -> LPARAM
# clrBk : COLORREF -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。