Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
hwndHWNDinライブプレビュー画像を設定する対象のウィンドウハンドル。
hbmpHBITMAPinライブプレビューとして表示するビットマップのハンドル。
pptClientPOINT*inoptionalクライアント領域の表示オフセットを示すPOINT。NULL可。
dwSITFlagsDWORDinプレビュー表示動作を制御するDWM_SIT_系フラグ。

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT DwmSetIconicLivePreviewBitmap(HWND hwnd, HBITMAP hbmp, POINT* pptClient, DWORD dwSITFlags)
#uselib "dwmapi.dll"
#cfunc global DwmSetIconicLivePreviewBitmap "DwmSetIconicLivePreviewBitmap" intptr, intptr, var, int
; res = DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)
; hwnd : HWND -> "intptr"
; hbmp : HBITMAP -> "intptr"
; pptClient : POINT* optional -> "var"
; dwSITFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dwmapi = windows.NewLazySystemDLL("dwmapi.dll")
	procDwmSetIconicLivePreviewBitmap = dwmapi.NewProc("DwmSetIconicLivePreviewBitmap")
)

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

extern "dwmapi" fn DwmSetIconicLivePreviewBitmap(
    hwnd: ?*anyopaque, // HWND
    hbmp: ?*anyopaque, // HBITMAP
    pptClient: [*c]POINT, // POINT* optional
    dwSITFlags: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc DwmSetIconicLivePreviewBitmap(
    hwnd: pointer,  # HWND
    hbmp: pointer,  # HBITMAP
    pptClient: ptr POINT,  # POINT* optional
    dwSITFlags: uint32  # DWORD
): int32 {.importc: "DwmSetIconicLivePreviewBitmap", stdcall, dynlib: "dwmapi.dll".}
pragma(lib, "dwmapi");
extern(Windows)
int DwmSetIconicLivePreviewBitmap(
    void* hwnd,   // HWND
    void* hbmp,   // HBITMAP
    POINT* pptClient,   // POINT* optional
    uint dwSITFlags   // DWORD
);
ccall((:DwmSetIconicLivePreviewBitmap, "dwmapi.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Ptr{POINT}, UInt32),
      hwnd, hbmp, pptClient, dwSITFlags)
# hwnd : HWND -> Ptr{Cvoid}
# hbmp : HBITMAP -> Ptr{Cvoid}
# pptClient : POINT* optional -> Ptr{POINT}
# dwSITFlags : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DwmSetIconicLivePreviewBitmap(
    void* hwnd,
    void* hbmp,
    void* pptClient,
    uint32_t dwSITFlags);
]]
local dwmapi = ffi.load("dwmapi")
-- dwmapi.DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)
-- hwnd : HWND
-- hbmp : HBITMAP
-- pptClient : POINT* optional
-- dwSITFlags : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dwmapi.dll');
const DwmSetIconicLivePreviewBitmap = lib.func('__stdcall', 'DwmSetIconicLivePreviewBitmap', 'int32_t', ['void *', 'void *', 'void *', 'uint32_t']);
// DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)
// hwnd : HWND -> 'void *'
// hbmp : HBITMAP -> 'void *'
// pptClient : POINT* optional -> 'void *'
// dwSITFlags : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dwmapi.dll", {
  DwmSetIconicLivePreviewBitmap: { parameters: ["pointer", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags)
// hwnd : HWND -> "pointer"
// hbmp : HBITMAP -> "pointer"
// pptClient : POINT* optional -> "pointer"
// dwSITFlags : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DwmSetIconicLivePreviewBitmap(
    void* hwnd,
    void* hbmp,
    void* pptClient,
    uint32_t dwSITFlags);
C, "dwmapi.dll");
// $ffi->DwmSetIconicLivePreviewBitmap(hwnd, hbmp, pptClient, dwSITFlags);
// hwnd : HWND
// hbmp : HBITMAP
// pptClient : POINT* optional
// 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 DwmSetIconicLivePreviewBitmap(
        Pointer hwnd,   // HWND
        Pointer hbmp,   // HBITMAP
        Pointer pptClient,   // POINT* optional
        int dwSITFlags   // DWORD
    );
}
@[Link("dwmapi")]
lib Libdwmapi
  fun DwmSetIconicLivePreviewBitmap = DwmSetIconicLivePreviewBitmap(
    hwnd : Void*,   # HWND
    hbmp : Void*,   # HBITMAP
    pptClient : POINT*,   # POINT* optional
    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 DwmSetIconicLivePreviewBitmapNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef DwmSetIconicLivePreviewBitmapDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final DwmSetIconicLivePreviewBitmap = DynamicLibrary.open('dwmapi.dll')
    .lookupFunction<DwmSetIconicLivePreviewBitmapNative, DwmSetIconicLivePreviewBitmapDart>('DwmSetIconicLivePreviewBitmap');
// hwnd : HWND -> Pointer<Void>
// hbmp : HBITMAP -> Pointer<Void>
// pptClient : POINT* optional -> Pointer<Void>
// dwSITFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DwmSetIconicLivePreviewBitmap(
  hwnd: THandle;   // HWND
  hbmp: THandle;   // HBITMAP
  pptClient: Pointer;   // POINT* optional
  dwSITFlags: DWORD   // DWORD
): Integer; stdcall;
  external 'dwmapi.dll' name 'DwmSetIconicLivePreviewBitmap';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let dwmseticoniclivepreviewbitmap =
  foreign "DwmSetIconicLivePreviewBitmap"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hwnd : HWND -> (ptr void) *)
(* hbmp : HBITMAP -> (ptr void) *)
(* pptClient : POINT* optional -> (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 ("DwmSetIconicLivePreviewBitmap" dwm-set-iconic-live-preview-bitmap :convention :stdcall) :int32
  (hwnd :pointer)   ; HWND
  (hbmp :pointer)   ; HBITMAP
  (ppt-client :pointer)   ; POINT* optional
  (dw-sitflags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DwmSetIconicLivePreviewBitmap = Win32::API::More->new('dwmapi',
    'int DwmSetIconicLivePreviewBitmap(HANDLE hwnd, HANDLE hbmp, LPVOID pptClient, DWORD dwSITFlags)');
# my $ret = $DwmSetIconicLivePreviewBitmap->Call($hwnd, $hbmp, $pptClient, $dwSITFlags);
# hwnd : HWND -> HANDLE
# hbmp : HBITMAP -> HANDLE
# pptClient : POINT* optional -> LPVOID
# dwSITFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型