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

BufferedPaintClear

関数
バッファの指定矩形領域をクリアする。
DLLUXTHEME.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT BufferedPaintClear(
    INT_PTR hBufferedPaint,
    const RECT* prc   // optional
);

パラメーター

名前方向説明
hBufferedPaintINT_PTRinBeginBufferedPaint によって取得した、バッファリングされた描画コンテキストのハンドルです。
prcRECT*inoptionalクリアする矩形を指定する RECT 構造体へのポインターです。このパラメーターに NULL を設定すると、バッファ全体が対象になります。

戻り値の型: HRESULT

公式ドキュメント

バッファ内の指定された矩形を ARGB = {0,0,0,0} にクリアします。

戻り値

型: HRESULT

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

解説(Remarks)

この関数はバッファのビットに直接アクセスするため、GDI 関数を呼び出してバッファを消去するよりも高速です。

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

各言語での呼び出し定義

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

HRESULT BufferedPaintClear(
    INT_PTR hBufferedPaint,
    const RECT* prc   // optional
);
[DllImport("UXTHEME.dll", ExactSpelling = true)]
static extern int BufferedPaintClear(
    IntPtr hBufferedPaint,   // INT_PTR
    IntPtr prc   // RECT* optional
);
<DllImport("UXTHEME.dll", ExactSpelling:=True)>
Public Shared Function BufferedPaintClear(
    hBufferedPaint As IntPtr,   ' INT_PTR
    prc As IntPtr   ' RECT* optional
) As Integer
End Function
' hBufferedPaint : INT_PTR
' prc : RECT* optional
Declare PtrSafe Function BufferedPaintClear Lib "uxtheme" ( _
    ByVal hBufferedPaint As LongPtr, _
    ByVal prc As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

BufferedPaintClear = ctypes.windll.uxtheme.BufferedPaintClear
BufferedPaintClear.restype = ctypes.c_int
BufferedPaintClear.argtypes = [
    ctypes.c_ssize_t,  # hBufferedPaint : INT_PTR
    ctypes.c_void_p,  # prc : RECT* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UXTHEME.dll')
BufferedPaintClear = Fiddle::Function.new(
  lib['BufferedPaintClear'],
  [
    Fiddle::TYPE_INTPTR_T,  # hBufferedPaint : INT_PTR
    Fiddle::TYPE_VOIDP,  # prc : RECT* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "uxtheme")]
extern "system" {
    fn BufferedPaintClear(
        hBufferedPaint: isize,  // INT_PTR
        prc: *const RECT  // RECT* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("UXTHEME.dll")]
public static extern int BufferedPaintClear(IntPtr hBufferedPaint, IntPtr prc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UXTHEME_BufferedPaintClear' -Namespace Win32 -PassThru
# $api::BufferedPaintClear(hBufferedPaint, prc)
#uselib "UXTHEME.dll"
#func global BufferedPaintClear "BufferedPaintClear" sptr, sptr
; BufferedPaintClear hBufferedPaint, varptr(prc)   ; 戻り値は stat
; hBufferedPaint : INT_PTR -> "sptr"
; prc : RECT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "UXTHEME.dll"
#cfunc global BufferedPaintClear "BufferedPaintClear" sptr, var
; res = BufferedPaintClear(hBufferedPaint, prc)
; hBufferedPaint : INT_PTR -> "sptr"
; prc : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT BufferedPaintClear(INT_PTR hBufferedPaint, RECT* prc)
#uselib "UXTHEME.dll"
#cfunc global BufferedPaintClear "BufferedPaintClear" intptr, var
; res = BufferedPaintClear(hBufferedPaint, prc)
; hBufferedPaint : INT_PTR -> "intptr"
; prc : RECT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uxtheme = windows.NewLazySystemDLL("UXTHEME.dll")
	procBufferedPaintClear = uxtheme.NewProc("BufferedPaintClear")
)

// hBufferedPaint (INT_PTR), prc (RECT* optional)
r1, _, err := procBufferedPaintClear.Call(
	uintptr(hBufferedPaint),
	uintptr(prc),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function BufferedPaintClear(
  hBufferedPaint: NativeInt;   // INT_PTR
  prc: Pointer   // RECT* optional
): Integer; stdcall;
  external 'UXTHEME.dll' name 'BufferedPaintClear';
result := DllCall("UXTHEME\BufferedPaintClear"
    , "Ptr", hBufferedPaint   ; INT_PTR
    , "Ptr", prc   ; RECT* optional
    , "Int")   ; return: HRESULT
●BufferedPaintClear(hBufferedPaint, prc) = DLL("UXTHEME.dll", "int BufferedPaintClear(int, void*)")
# 呼び出し: BufferedPaintClear(hBufferedPaint, prc)
# hBufferedPaint : INT_PTR -> "int"
# prc : RECT* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef BufferedPaintClearNative = Int32 Function(IntPtr, Pointer<Void>);
typedef BufferedPaintClearDart = int Function(int, Pointer<Void>);
final BufferedPaintClear = DynamicLibrary.open('UXTHEME.dll')
    .lookupFunction<BufferedPaintClearNative, BufferedPaintClearDart>('BufferedPaintClear');
// hBufferedPaint : INT_PTR -> IntPtr
// prc : RECT* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BufferedPaintClear(
  hBufferedPaint: NativeInt;   // INT_PTR
  prc: Pointer   // RECT* optional
): Integer; stdcall;
  external 'UXTHEME.dll' name 'BufferedPaintClear';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BufferedPaintClear"
  c_BufferedPaintClear :: CIntPtr -> Ptr () -> IO Int32
-- hBufferedPaint : INT_PTR -> CIntPtr
-- prc : RECT* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let bufferedpaintclear =
  foreign "BufferedPaintClear"
    (intptr_t @-> (ptr void) @-> returning int32_t)
(* hBufferedPaint : INT_PTR -> intptr_t *)
(* prc : RECT* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library uxtheme (t "UXTHEME.dll"))
(cffi:use-foreign-library uxtheme)

(cffi:defcfun ("BufferedPaintClear" buffered-paint-clear :convention :stdcall) :int32
  (h-buffered-paint :int64)   ; INT_PTR
  (prc :pointer))   ; RECT* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BufferedPaintClear = Win32::API::More->new('UXTHEME',
    'int BufferedPaintClear(LPARAM hBufferedPaint, LPVOID prc)');
# my $ret = $BufferedPaintClear->Call($hBufferedPaint, $prc);
# hBufferedPaint : INT_PTR -> LPARAM
# prc : RECT* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型