BeginPaint

関数

ウィンドウの描画を開始し描画用デバイスコンテキストを取得する。

DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HDC BeginPaint(
    HWND hWnd,
    PAINTSTRUCT* lpPaint
);

パラメーター

名前	型	方向	説明
hWnd	HWND	in	再描画するウィンドウへのハンドル。
lpPaint	PAINTSTRUCT*	out	描画情報を受け取る PAINTSTRUCT 構造体へのポインター。

戻り値の型: HDC

公式ドキュメント

BeginPaint 関数は、指定したウィンドウを描画用に準備し、描画に関する情報を PAINTSTRUCT 構造体に格納します。

戻り値

関数が成功した場合、戻り値は指定したウィンドウのディスプレイデバイスコンテキストへのハンドルです。

関数が失敗した場合、戻り値は NULL となり、利用可能なディスプレイデバイスコンテキストがないことを示します。

解説(Remarks)

BeginPaint 関数は、更新領域の外側にある領域を除外するように、デバイスコンテキストのクリッピング領域を自動的に設定します。更新領域は、InvalidateRect 関数または InvalidateRgn 関数によって、またサイズ変更、移動、作成、スクロール、その他クライアント領域に影響を与える操作の後にシステムによって設定されます。更新領域が消去対象としてマークされている場合、BeginPaint はウィンドウに WM_ERASEBKGND メッセージを送信します。

アプリケーションは、WM_PAINT メッセージに応答する場合を除き、BeginPaint を呼び出してはなりません。BeginPaint の各呼び出しには、対応する EndPaint 関数の呼び出しが必要です。

描画対象の領域内にキャレットがある場合、BeginPaint はキャレットが消去されるのを防ぐため、自動的にキャレットを非表示にします。

ウィンドウのクラスに背景ブラシが設定されている場合、BeginPaint は戻る前にそのブラシを使用して更新領域の背景を消去します。

DPI 仮想化

この API は DPI 仮想化に参加しません。返される出力は常に物理ピクセル単位です。

例

例については、Drawing in the Client Area を参照してください。

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

各言語での呼び出し定義

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

HDC BeginPaint(
    HWND hWnd,
    PAINTSTRUCT* lpPaint
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr BeginPaint(
    IntPtr hWnd,   // HWND
    IntPtr lpPaint   // PAINTSTRUCT* out
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function BeginPaint(
    hWnd As IntPtr,   ' HWND
    lpPaint As IntPtr   ' PAINTSTRUCT* out
) As IntPtr
End Function

' hWnd : HWND
' lpPaint : PAINTSTRUCT* out
Declare PtrSafe Function BeginPaint Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lpPaint As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

BeginPaint = ctypes.windll.user32.BeginPaint
BeginPaint.restype = ctypes.c_void_p
BeginPaint.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND
    ctypes.c_void_p,  # lpPaint : PAINTSTRUCT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
BeginPaint = Fiddle::Function.new(
  lib['BeginPaint'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND
    Fiddle::TYPE_VOIDP,  # lpPaint : PAINTSTRUCT* out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "user32")]
extern "system" {
    fn BeginPaint(
        hWnd: *mut core::ffi::c_void,  // HWND
        lpPaint: *mut PAINTSTRUCT  // PAINTSTRUCT* out
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr BeginPaint(IntPtr hWnd, IntPtr lpPaint);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_BeginPaint' -Namespace Win32 -PassThru
# $api::BeginPaint(hWnd, lpPaint)

#uselib "USER32.dll"
#func global BeginPaint "BeginPaint" sptr, sptr
; BeginPaint hWnd, varptr(lpPaint)   ; 戻り値は stat
; hWnd : HWND -> "sptr"
; lpPaint : PAINTSTRUCT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global BeginPaint "BeginPaint" sptr, var
; res = BeginPaint(hWnd, lpPaint)
; hWnd : HWND -> "sptr"
; lpPaint : PAINTSTRUCT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global BeginPaint "BeginPaint" sptr, sptr
; res = BeginPaint(hWnd, varptr(lpPaint))
; hWnd : HWND -> "sptr"
; lpPaint : PAINTSTRUCT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。