ホーム › Graphics.Dwm › DwmSetIconicLivePreviewBitmap

DwmSetIconicLivePreviewBitmap

関数

ウィンドウのライブプレビュー用ビットマップを設定する。

DLLdwmapi.dll呼出規約winapi対応OSWindows 7 以降

シグネチャ

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

HRESULT DwmSetIconicLivePreviewBitmap(
    HWND hwnd,
    HBITMAP hbmp,
    POINT* pptClient,   // optional
    DWORD dwSITFlags
);

パラメーター

名前	型	方向	説明
hwnd	HWND	in	ウィンドウへのハンドル。このウィンドウは呼び出し元のプロセスに属している必要があります。
hbmp	HBITMAP	in	hwnd で指定したウィンドウを表すビットマップへのハンドル。
pptClient	POINT*	inoptional	ホストウィンドウのフレームを基準とした、タブウィンドウのクライアント領域 (クライアントウィンドウフレームの内側にあるコンテンツ領域) のオフセット。このオフセットにより、タブウィンドウの内容をフレームなしで描画する場合でも、ライブプレビューで正しく描画できます。
dwSITFlags	DWORD	in	ライブプレビューの表示オプション。このパラメーターには 0 または次の値を指定できます。 DWM_SIT_DISPLAYFRAME (0x00000001) 0x00000001。指定されたビットマップの周囲にフレームを表示します。

戻り値の型: HRESULT

公式ドキュメント

ウィンドウまたはタブのライブプレビュー (Peek プレビューとも呼ばれます) を表示するための、静的なアイコンビットマップを設定します。タスクバーはこのビットマップを使用して、ウィンドウまたはタブのフルサイズのプレビューを表示できます。

戻り値

関数が成功した場合は S_OK を、それ以外の場合はエラー値を返します。このビットマップはキャッシュされないため、アプリケーションがこの関数を呼び出した時点でウィンドウがプレビューされていない場合、関数は成功コードを返しますが、ビットマップは破棄され使用されない点に注意してください。

解説(Remarks)

ウィンドウのライブプレビュー (Peek プレビューとも呼ばれます) は、ユーザーがタスクバー上のウィンドウのサムネイルにマウスポインターを合わせたとき、または ALT+TAB ウィンドウでサムネイルにフォーカスを移したときに表示されます。このビューはウィンドウのフルサイズのビューであり、スナップショットまたはアイコン表現のいずれかにできます。

ウィンドウは通常、WM_DWMSENDICONICLIVEPREVIEWBITMAP メッセージに応答して DwmSetIconicLivePreviewBitmap 関数を呼び出します。返すビットマップは、ウィンドウまたはフレームのクライアント領域より大きくてはならず、色深度は 32 ビットである必要があります。

デスクトップウィンドウマネージャー (DWM) はビットマップのコピーを使用しますが、元のビットマップの所有権は呼び出し元が保持し、不要になった時点でそのビットマップが使用しているリソースを解放する責任があります。DWM は、ライブプレビュー表現の表示を停止すると、そのビットマップのコピーを保持しません。

例

アプリケーションのウィンドウのライブプレビューとして使用する静的なアイコンビットマップを設定するには、アプリケーションは DwmSetIconicLivePreviewBitmap 関数を呼び出します。このビットマップを設定するには、次のコードに示すように、アプリケーションは DwmSetWindowAttribute を呼び出して、非クライアント領域の描画に関するウィンドウ属性に DWMWA_FORCE_ICONIC_REPRESENTATION と DWMWA_HAS_ICONIC_BITMAP を設定する必要があります。

            // Set DWM window attributes to provide the iconic bitmap, and 
            // to always render the thumbnail using the iconic bitmap.
            BOOL fForceIconic = TRUE;
            BOOL fHasIconicBitmap = TRUE;

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

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

次に、次のコードに示すように、アプリケーションは DwmSetIconicLivePreviewBitmap を呼び出して WM_DWMSENDICONICLIVEPREVIEWBITMAP メッセージに応答します。

        case WM_DWMSENDICONICLIVEPREVIEWBITMAP:
        {
            // This window is being asked to provide a bitmap to show in Peek preview.
            // This indicates the thumbnail in the taskbar is being previewed.
            RECT rectWindow = {0, 0, 0, 0};
            if (GetClientRect(hwnd, &rectWindow))
            {
                nWidth = rectWindow.right - rectWindow.left;
                nHeight = rectWindow.bottom - rectWindow.top;
            }

            hbm = CreateDIB(nWidth, nHeight);
            if (hbm)
            {
                hr = DwmSetIconicLivePreviewBitmap(hwnd, hbm, NULL, DWM_SIT_DISPLAYFRAME);
                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 DwmSetIconicLivePreviewBitmap(
    HWND hwnd,
    HBITMAP hbmp,
    POINT* pptClient,   // optional
    DWORD dwSITFlags
);

[DllImport("dwmapi.dll", ExactSpelling = true)]
static extern int DwmSetIconicLivePreviewBitmap(
    IntPtr hwnd,   // HWND
    IntPtr hbmp,   // HBITMAP
    IntPtr pptClient,   // POINT* optional
    uint dwSITFlags   // DWORD
);

<DllImport("dwmapi.dll", ExactSpelling:=True)>
Public Shared Function DwmSetIconicLivePreviewBitmap(
    hwnd As IntPtr,   ' HWND
    hbmp As IntPtr,   ' HBITMAP
    pptClient As IntPtr,   ' POINT* optional
    dwSITFlags As UInteger   ' DWORD
) As Integer
End Function

' hwnd : HWND
' hbmp : HBITMAP
' pptClient : POINT* optional
' dwSITFlags : DWORD
Declare PtrSafe Function DwmSetIconicLivePreviewBitmap Lib "dwmapi" ( _
    ByVal hwnd As LongPtr, _
    ByVal hbmp As LongPtr, _
    ByVal pptClient 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

DwmSetIconicLivePreviewBitmap = ctypes.windll.dwmapi.DwmSetIconicLivePreviewBitmap
DwmSetIconicLivePreviewBitmap.restype = ctypes.c_int
DwmSetIconicLivePreviewBitmap.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.HANDLE,  # hbmp : HBITMAP
    ctypes.c_void_p,  # pptClient : POINT* optional
    wintypes.DWORD,  # dwSITFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dwmapi.dll')
DwmSetIconicLivePreviewBitmap = Fiddle::Function.new(
  lib['DwmSetIconicLivePreviewBitmap'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    Fiddle::TYPE_VOIDP,  # hbmp : HBITMAP
    Fiddle::TYPE_VOIDP,  # pptClient : POINT* optional
    -Fiddle::TYPE_INT,  # dwSITFlags : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "dwmapi")]
extern "system" {
    fn DwmSetIconicLivePreviewBitmap(
        hwnd: *mut core::ffi::c_void,  // HWND
        hbmp: *mut core::ffi::c_void,  // HBITMAP
        pptClient: *mut POINT,  // POINT* optional
        dwSITFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dwmapi.dll")]
public static extern int DwmSetIconicLivePreviewBitmap(IntPtr hwnd, IntPtr hbmp, IntPtr pptClient, uint dwSITFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dwmapi_DwmSetIconicLivePreviewBitmap' -Namespace Win32 -PassThru
# $api::DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)

#uselib "dwmapi.dll"
#func global DwmSetIconicLivePreviewBitmap "DwmSetIconicLivePreviewBitmap" sptr, sptr, sptr, sptr
; DwmSetIconicLivePreviewBitmap hwnd, hbmp, varptr(pptClient), dwSITFlags   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; hbmp : HBITMAP -> "sptr"
; pptClient : POINT* optional -> "sptr"
; dwSITFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dwmapi.dll"
#cfunc global DwmSetIconicLivePreviewBitmap "DwmSetIconicLivePreviewBitmap" sptr, sptr, var, int
; res = DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)
; hwnd : HWND -> "sptr"
; hbmp : HBITMAP -> "sptr"
; pptClient : POINT* optional -> "var"
; dwSITFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dwmapi.dll"
#cfunc global DwmSetIconicLivePreviewBitmap "DwmSetIconicLivePreviewBitmap" sptr, sptr, sptr, int
; res = DwmSetIconicLivePreviewBitmap(hwnd, hbmp, varptr(pptClient), dwSITFlags)
; hwnd : HWND -> "sptr"
; hbmp : HBITMAP -> "sptr"
; pptClient : POINT* optional -> "sptr"
; dwSITFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。