Win32 API 日本語リファレンス
ホーム › Graphics.Dwm › DwmSetIconicThumbnail

DwmSetIconicThumbnail

関数
ウィンドウのアイコン化時に表示するサムネイル画像を設定する。
DLLdwmapi.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT DwmSetIconicThumbnail(
    HWND hwnd,
    HBITMAP hbmp,
    DWORD dwSITFlags
);

パラメーター

名前型方向説明
hwndHWNDinウィンドウまたはタブへのハンドル。このウィンドウは呼び出し元のプロセスに属している必要があります。
hbmpHBITMAPinhwnd で指定したウィンドウを表すビットマップへのハンドル。
dwSITFlagsDWORDin

サムネイルの表示オプション。次のいずれかの値を指定します。

0 (0x00000000)

指定されたサムネイルの周囲にフレームを表示しません。

DWM_SIT_DISPLAYFRAME (0x00000001)

指定されたサムネイルの周囲にフレームを表示します。

戻り値の型: HRESULT

公式ドキュメント

ウィンドウまたはタブのサムネイル表現として使用する、静的でアイコン化されたビットマップを設定します。タスクバーはこのビットマップを、そのウィンドウまたはタブのサムネイル切り替え先として使用できます。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

アプリケーションは通常、自身のウィンドウに対する WM_DWMSENDICONICTHUMBNAIL メッセージを受け取った後に DwmSetIconicThumbnail 関数を呼び出します。サムネイルは、そのメッセージで指定された x 座標および y 座標の最大値を超えてはなりません。また、サムネイルは 32 ビットの色深度である必要があります。

アプリケーションは DwmInvalidateIconicBitmaps を呼び出して、アイコン化されたサムネイルとライブプレビューのビットマップが古くなっており、更新が必要であることを Desktop Window Manager (DWM) に通知します。その後 DWM は、必要になった時点で新しいバージョンをウィンドウに要求します。ただし、DWM のビットマップキャッシュがいっぱいの場合、DWM は更新されたバージョンを要求しません。

DWM はビットマップのコピーを使用しますが、メモリの制約により、このコピーはいつでも解放される可能性があります。コピーが解放されてもウィンドウには通知されませんが、サムネイルが再び必要になったときに、後続の WM_DWMSENDICONICTHUMBNAIL 要求を受け取ることがあります。呼び出し元は元のビットマップの所有権を保持し、不要になった時点でそれが使用しているリソースを解放する責任があります。

例

DwmSetIconicThumbnail を呼び出す前に、アプリケーションはまず DwmSetWindowAttribute 関数を呼び出して、次の例に示すように DWMWA_FORCE_ICONIC_REPRESENTATION 属性と DWMWA_HAS_ICONIC_BITMAP 属性を設定する必要があります。

            // アイコン化されたビットマップを提供し、常にそのビットマップを使用して
            // サムネイルを描画するように DWM のウィンドウ属性を設定する
            BOOL fForceIconic = TRUE;
            BOOL fHasIconicBitmap = TRUE;

            DwmSetWindowAttribute(
                hwnd,
                DWMWA_FORCE_ICONIC_REPRESENTATION,
                &fForceIconic,
                sizeof(fForceIconic));

            DwmSetWindowAttribute(
                hwnd,
                DWMWA_HAS_ICONIC_BITMAP,
                &fHasIconicBitmap,
                sizeof(fHasIconicBitmap));

次に、アプリケーションは次の例に示すように、WM_DWMSENDICONICTHUMBNAIL メッセージに応答して DwmSetIconicThumbnail 関数を呼び出します。

        case WM_DWMSENDICONICTHUMBNAIL:
        {    
            // このウィンドウはアイコン化されたビットマップの提供を求められている。これは
            // サムネイルが描画されようとしていることを示す。
            hbm = CreateDIB(HIWORD(lParam), LOWORD(lParam)); 
            if (hbm)
            {
                hr = DwmSetIconicThumbnail(hwnd, hbm, 0);
                DeleteObject(hbm);
            }
        }
        break;

完全なサンプルコードについては、Customize an Iconic Thumbnail and a Live Preview Bitmap のサンプルを参照してください。

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

各言語での呼び出し定義

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

HRESULT DwmSetIconicThumbnail(
    HWND hwnd,
    HBITMAP hbmp,
    DWORD dwSITFlags
);
[DllImport("dwmapi.dll", ExactSpelling = true)]
static extern int DwmSetIconicThumbnail(
    IntPtr hwnd,   // HWND
    IntPtr hbmp,   // HBITMAP
    uint dwSITFlags   // DWORD
);
<DllImport("dwmapi.dll", ExactSpelling:=True)>
Public Shared Function DwmSetIconicThumbnail(
    hwnd As IntPtr,   ' HWND
    hbmp As IntPtr,   ' HBITMAP
    dwSITFlags As UInteger   ' DWORD
) As Integer
End Function
' hwnd : HWND
' hbmp : HBITMAP
' dwSITFlags : DWORD
Declare PtrSafe Function DwmSetIconicThumbnail Lib "dwmapi" ( _
    ByVal hwnd As LongPtr, _
    ByVal hbmp As LongPtr, _
    ByVal dwSITFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DwmSetIconicThumbnail = ctypes.windll.dwmapi.DwmSetIconicThumbnail
DwmSetIconicThumbnail.restype = ctypes.c_int
DwmSetIconicThumbnail.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.HANDLE,  # hbmp : HBITMAP
    wintypes.DWORD,  # dwSITFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dwmapi = windows.NewLazySystemDLL("dwmapi.dll")
	procDwmSetIconicThumbnail = dwmapi.NewProc("DwmSetIconicThumbnail")
)

// hwnd (HWND), hbmp (HBITMAP), dwSITFlags (DWORD)
r1, _, err := procDwmSetIconicThumbnail.Call(
	uintptr(hwnd),
	uintptr(hbmp),
	uintptr(dwSITFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function DwmSetIconicThumbnail(
  hwnd: THandle;   // HWND
  hbmp: THandle;   // HBITMAP
  dwSITFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'dwmapi.dll' name 'DwmSetIconicThumbnail';
result := DllCall("dwmapi\DwmSetIconicThumbnail"
    , "Ptr", hwnd   ; HWND
    , "Ptr", hbmp   ; HBITMAP
    , "UInt", dwSITFlags   ; DWORD
    , "Int")   ; return: HRESULT
●DwmSetIconicThumbnail(hwnd, hbmp, dwSITFlags) = DLL("dwmapi.dll", "int DwmSetIconicThumbnail(void*, void*, dword)")
# 呼び出し: DwmSetIconicThumbnail(hwnd, hbmp, dwSITFlags)
# hwnd : HWND -> "void*"
# hbmp : HBITMAP -> "void*"
# dwSITFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DwmSetIconicThumbnailNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef DwmSetIconicThumbnailDart = int Function(Pointer<Void>, Pointer<Void>, int);
final DwmSetIconicThumbnail = DynamicLibrary.open('dwmapi.dll')
    .lookupFunction<DwmSetIconicThumbnailNative, DwmSetIconicThumbnailDart>('DwmSetIconicThumbnail');
// hwnd : HWND -> Pointer<Void>
// hbmp : HBITMAP -> Pointer<Void>
// dwSITFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DwmSetIconicThumbnail(
  hwnd: THandle;   // HWND
  hbmp: THandle;   // HBITMAP
  dwSITFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'dwmapi.dll' name 'DwmSetIconicThumbnail';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DwmSetIconicThumbnail"
  c_DwmSetIconicThumbnail :: Ptr () -> Ptr () -> Word32 -> IO Int32
-- hwnd : HWND -> Ptr ()
-- hbmp : HBITMAP -> Ptr ()
-- dwSITFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dwmseticonicthumbnail =
  foreign "DwmSetIconicThumbnail"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hwnd : HWND -> (ptr void) *)
(* hbmp : HBITMAP -> (ptr void) *)
(* dwSITFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dwmapi (t "dwmapi.dll"))
(cffi:use-foreign-library dwmapi)

(cffi:defcfun ("DwmSetIconicThumbnail" dwm-set-iconic-thumbnail :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND
  (hbmp :pointer)   ; HBITMAP
  (dw-sitflags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DwmSetIconicThumbnail = Win32::API::More->new('dwmapi',
    'int DwmSetIconicThumbnail(HANDLE hwnd, HANDLE hbmp, DWORD dwSITFlags)');
# my $ret = $DwmSetIconicThumbnail->Call($hwnd, $hbmp, $dwSITFlags);
# hwnd : HWND -> HANDLE
# hbmp : HBITMAP -> HANDLE
# dwSITFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。