ホーム › UI.Controls › ImageList_SetOverlayImage
ImageList_SetOverlayImage
関数イメージリストの画像をオーバーレイマスクに指定する。
シグネチャ
// COMCTL32.dll
#include <windows.h>
BOOL ImageList_SetOverlayImage(
HIMAGELIST himl,
INT iImage,
INT iOverlay
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| himl | HIMAGELIST | in | イメージリストへのハンドルです。 |
| iImage | INT | in | himl イメージリスト内の画像を示す 0 から始まるインデックスです。このインデックスは、オーバーレイマスクとして使用する画像を識別します。 |
| iOverlay | INT | in | オーバーレイマスクの 1 から始まるインデックスです。 |
戻り値の型: BOOL
公式ドキュメント
指定した画像を、オーバーレイマスクとして使用する画像のリストに追加します。イメージリストは、バージョン 4.70 以前では最大 4 個、バージョン 4.71 では最大 15 個のオーバーレイマスクを持つことができます。この関数は、指定した画像にオーバーレイマスクのインデックスを割り当てます。
戻り値
型: BOOL
成功した場合は 0 以外を、それ以外の場合は 0 を返します。
解説(Remarks)
オーバーレイマスクとは、別の画像の上に透過的に描画される画像です。オーバーレイマスクを画像の上に描画するには、ImageList_Draw 関数または ImageList_DrawEx 関数を呼び出します。これらの関数の fStyle パラメーターでは、INDEXTOOVERLAYMASK マクロを使用してオーバーレイマスクのインデックスを指定できます。
イメージリストがマスクを使用して作成されていない場合、このメソッドの呼び出しは失敗し、E_INVALIDARG を返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// COMCTL32.dll
#include <windows.h>
BOOL ImageList_SetOverlayImage(
HIMAGELIST himl,
INT iImage,
INT iOverlay
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern bool ImageList_SetOverlayImage(
IntPtr himl, // HIMAGELIST
int iImage, // INT
int iOverlay // INT
);<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function ImageList_SetOverlayImage(
himl As IntPtr, ' HIMAGELIST
iImage As Integer, ' INT
iOverlay As Integer ' INT
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' himl : HIMAGELIST
' iImage : INT
' iOverlay : INT
Declare PtrSafe Function ImageList_SetOverlayImage Lib "comctl32" ( _
ByVal himl As LongPtr, _
ByVal iImage As Long, _
ByVal iOverlay As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ImageList_SetOverlayImage = ctypes.windll.comctl32.ImageList_SetOverlayImage
ImageList_SetOverlayImage.restype = wintypes.BOOL
ImageList_SetOverlayImage.argtypes = [
ctypes.c_ssize_t, # himl : HIMAGELIST
ctypes.c_int, # iImage : INT
ctypes.c_int, # iOverlay : INT
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('COMCTL32.dll')
ImageList_SetOverlayImage = Fiddle::Function.new(
lib['ImageList_SetOverlayImage'],
[
Fiddle::TYPE_INTPTR_T, # himl : HIMAGELIST
Fiddle::TYPE_INT, # iImage : INT
Fiddle::TYPE_INT, # iOverlay : INT
],
Fiddle::TYPE_INT)#[link(name = "comctl32")]
extern "system" {
fn ImageList_SetOverlayImage(
himl: isize, // HIMAGELIST
iImage: i32, // INT
iOverlay: i32 // INT
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("COMCTL32.dll")]
public static extern bool ImageList_SetOverlayImage(IntPtr himl, int iImage, int iOverlay);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_ImageList_SetOverlayImage' -Namespace Win32 -PassThru
# $api::ImageList_SetOverlayImage(himl, iImage, iOverlay)#uselib "COMCTL32.dll"
#func global ImageList_SetOverlayImage "ImageList_SetOverlayImage" sptr, sptr, sptr
; ImageList_SetOverlayImage himl, iImage, iOverlay ; 戻り値は stat
; himl : HIMAGELIST -> "sptr"
; iImage : INT -> "sptr"
; iOverlay : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "COMCTL32.dll"
#cfunc global ImageList_SetOverlayImage "ImageList_SetOverlayImage" sptr, int, int
; res = ImageList_SetOverlayImage(himl, iImage, iOverlay)
; himl : HIMAGELIST -> "sptr"
; iImage : INT -> "int"
; iOverlay : INT -> "int"; BOOL ImageList_SetOverlayImage(HIMAGELIST himl, INT iImage, INT iOverlay)
#uselib "COMCTL32.dll"
#cfunc global ImageList_SetOverlayImage "ImageList_SetOverlayImage" intptr, int, int
; res = ImageList_SetOverlayImage(himl, iImage, iOverlay)
; himl : HIMAGELIST -> "intptr"
; iImage : INT -> "int"
; iOverlay : INT -> "int"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
procImageList_SetOverlayImage = comctl32.NewProc("ImageList_SetOverlayImage")
)
// himl (HIMAGELIST), iImage (INT), iOverlay (INT)
r1, _, err := procImageList_SetOverlayImage.Call(
uintptr(himl),
uintptr(iImage),
uintptr(iOverlay),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ImageList_SetOverlayImage(
himl: NativeInt; // HIMAGELIST
iImage: Integer; // INT
iOverlay: Integer // INT
): BOOL; stdcall;
external 'COMCTL32.dll' name 'ImageList_SetOverlayImage';result := DllCall("COMCTL32\ImageList_SetOverlayImage"
, "Ptr", himl ; HIMAGELIST
, "Int", iImage ; INT
, "Int", iOverlay ; INT
, "Int") ; return: BOOL●ImageList_SetOverlayImage(himl, iImage, iOverlay) = DLL("COMCTL32.dll", "bool ImageList_SetOverlayImage(int, int, int)")
# 呼び出し: ImageList_SetOverlayImage(himl, iImage, iOverlay)
# himl : HIMAGELIST -> "int"
# iImage : INT -> "int"
# iOverlay : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "comctl32" fn ImageList_SetOverlayImage(
himl: isize, // HIMAGELIST
iImage: i32, // INT
iOverlay: i32 // INT
) callconv(std.os.windows.WINAPI) i32;proc ImageList_SetOverlayImage(
himl: int, # HIMAGELIST
iImage: int32, # INT
iOverlay: int32 # INT
): int32 {.importc: "ImageList_SetOverlayImage", stdcall, dynlib: "COMCTL32.dll".}pragma(lib, "comctl32");
extern(Windows)
int ImageList_SetOverlayImage(
ptrdiff_t himl, // HIMAGELIST
int iImage, // INT
int iOverlay // INT
);ccall((:ImageList_SetOverlayImage, "COMCTL32.dll"), stdcall, Int32,
(Int, Int32, Int32),
himl, iImage, iOverlay)
# himl : HIMAGELIST -> Int
# iImage : INT -> Int32
# iOverlay : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ImageList_SetOverlayImage(
intptr_t himl,
int32_t iImage,
int32_t iOverlay);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.ImageList_SetOverlayImage(himl, iImage, iOverlay)
-- himl : HIMAGELIST
-- iImage : INT
-- iOverlay : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const ImageList_SetOverlayImage = lib.func('__stdcall', 'ImageList_SetOverlayImage', 'int32_t', ['intptr_t', 'int32_t', 'int32_t']);
// ImageList_SetOverlayImage(himl, iImage, iOverlay)
// himl : HIMAGELIST -> 'intptr_t'
// iImage : INT -> 'int32_t'
// iOverlay : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("COMCTL32.dll", {
ImageList_SetOverlayImage: { parameters: ["isize", "i32", "i32"], result: "i32" },
});
// lib.symbols.ImageList_SetOverlayImage(himl, iImage, iOverlay)
// himl : HIMAGELIST -> "isize"
// iImage : INT -> "i32"
// iOverlay : INT -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ImageList_SetOverlayImage(
intptr_t himl,
int32_t iImage,
int32_t iOverlay);
C, "COMCTL32.dll");
// $ffi->ImageList_SetOverlayImage(himl, iImage, iOverlay);
// himl : HIMAGELIST
// iImage : INT
// iOverlay : 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 Comctl32 extends StdCallLibrary {
Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
boolean ImageList_SetOverlayImage(
long himl, // HIMAGELIST
int iImage, // INT
int iOverlay // INT
);
}@[Link("comctl32")]
lib LibCOMCTL32
fun ImageList_SetOverlayImage = ImageList_SetOverlayImage(
himl : LibC::SSizeT, # HIMAGELIST
iImage : Int32, # INT
iOverlay : Int32 # INT
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ImageList_SetOverlayImageNative = Int32 Function(IntPtr, Int32, Int32);
typedef ImageList_SetOverlayImageDart = int Function(int, int, int);
final ImageList_SetOverlayImage = DynamicLibrary.open('COMCTL32.dll')
.lookupFunction<ImageList_SetOverlayImageNative, ImageList_SetOverlayImageDart>('ImageList_SetOverlayImage');
// himl : HIMAGELIST -> IntPtr
// iImage : INT -> Int32
// iOverlay : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ImageList_SetOverlayImage(
himl: NativeInt; // HIMAGELIST
iImage: Integer; // INT
iOverlay: Integer // INT
): BOOL; stdcall;
external 'COMCTL32.dll' name 'ImageList_SetOverlayImage';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ImageList_SetOverlayImage"
c_ImageList_SetOverlayImage :: CIntPtr -> Int32 -> Int32 -> IO CInt
-- himl : HIMAGELIST -> CIntPtr
-- iImage : INT -> Int32
-- iOverlay : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let imagelist_setoverlayimage =
foreign "ImageList_SetOverlayImage"
(intptr_t @-> int32_t @-> int32_t @-> returning int32_t)
(* himl : HIMAGELIST -> intptr_t *)
(* iImage : INT -> int32_t *)
(* iOverlay : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)
(cffi:defcfun ("ImageList_SetOverlayImage" image-list-set-overlay-image :convention :stdcall) :int32
(himl :int64) ; HIMAGELIST
(i-image :int32) ; INT
(i-overlay :int32)) ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ImageList_SetOverlayImage = Win32::API::More->new('COMCTL32',
'BOOL ImageList_SetOverlayImage(LPARAM himl, int iImage, int iOverlay)');
# my $ret = $ImageList_SetOverlayImage->Call($himl, $iImage, $iOverlay);
# himl : HIMAGELIST -> LPARAM
# iImage : INT -> int
# iOverlay : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。