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

RedrawWindow

関数
フラグに従ってウィンドウの指定領域を更新・再描画する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

BOOL RedrawWindow(
    HWND hWnd,   // optional
    const RECT* lprcUpdate,   // optional
    HRGN hrgnUpdate,   // optional
    REDRAW_WINDOW_FLAGS flags
);

パラメーター

名前方向説明
hWndHWNDinoptional再描画するウィンドウへのハンドル。このパラメーターが NULL の場合、デスクトップウィンドウが更新されます。
lprcUpdateRECT*inoptional更新する四角形の座標(デバイス単位)を格納した RECT 構造体へのポインター。hrgnUpdate パラメーターがリージョンを指定している場合、このパラメーターは無視されます。
hrgnUpdateHRGNinoptional更新リージョンへのハンドル。hrgnUpdatelprcUpdate の両方のパラメーターが NULL の場合、クライアント領域全体が更新リージョンに追加されます。
flagsREDRAW_WINDOW_FLAGSin

1 つ以上の再描画フラグ。このパラメーターは、ウィンドウの無効化または有効化、再描画の制御、および RedrawWindow の影響を受けるウィンドウの制御に使用できます。

以下のフラグはウィンドウを無効化するために使用します。

フラグ(無効化) 説明
RDW_ERASE
ウィンドウが再描画されるときに WM_ERASEBKGND メッセージを受け取るようにします。RDW_INVALIDATE フラグも指定する必要があります。指定しない場合、RDW_ERASE は効果を持ちません。
RDW_FRAME
ウィンドウの非クライアント領域のうち更新リージョンと交差する部分が WM_NCPAINT メッセージを受け取るようにします。RDW_INVALIDATE フラグも指定する必要があります。指定しない場合、RDW_FRAME は効果を持ちません。WM_NCPAINT メッセージは、通常、RDW_UPDATENOW または RDW_ERASENOW のいずれかが指定されていない限り、RedrawWindow の実行中には送信されません。
RDW_INTERNALPAINT
ウィンドウのいずれかの部分が無効であるかどうかに関係なく、WM_PAINT メッセージがウィンドウにポストされるようにします。
RDW_INVALIDATE
lprcUpdate または hrgnUpdate を無効化します(NULL でないのは一方のみです)。両方が NULL の場合、ウィンドウ全体が無効化されます。

以下のフラグはウィンドウを有効化するために使用します。

フラグ(有効化) 説明
RDW_NOERASE
保留中の WM_ERASEBKGND メッセージを抑制します。
RDW_NOFRAME
保留中の WM_NCPAINT メッセージを抑制します。このフラグは RDW_VALIDATE とともに使用する必要があり、通常は RDW_NOCHILDREN とともに使用されます。RDW_NOFRAME はウィンドウの一部が正しく描画されない原因となる可能性があるため、注意して使用してください。
RDW_NOINTERNALPAINT
保留中の内部 WM_PAINT メッセージを抑制します。このフラグは、NULL でない更新領域に起因する WM_PAINT メッセージには影響しません。
RDW_VALIDATE
lprcUpdate または hrgnUpdate を有効化します(NULL でないのは一方のみです)。両方が NULL の場合、ウィンドウ全体が有効化されます。このフラグは内部 WM_PAINT メッセージには影響しません。

以下のフラグは再描画が行われるタイミングを制御します。これらのフラグのいずれかが指定されない限り、RedrawWindow は再描画を行いません。

フラグ 説明
RDW_ERASENOW
影響を受けるウィンドウ(RDW_ALLCHILDREN および RDW_NOCHILDREN フラグで指定されたもの)が、関数が戻る前に、必要に応じて WM_NCPAINT および WM_ERASEBKGND メッセージを受け取るようにします。WM_PAINT メッセージは通常のタイミングで受け取られます。
RDW_UPDATENOW
影響を受けるウィンドウ(RDW_ALLCHILDREN および RDW_NOCHILDREN フラグで指定されたもの)が、関数が戻る前に、必要に応じて WM_NCPAINTWM_ERASEBKGND、および WM_PAINT メッセージを受け取るようにします。

既定では、RedrawWindow の影響を受けるウィンドウは、指定したウィンドウが WS_CLIPCHILDREN スタイルを持つかどうかに依存します。WS_CLIPCHILDREN スタイルでない子ウィンドウは影響を受けません。WS_CLIPCHILDREN でないウィンドウは、WS_CLIPCHILDREN ウィンドウに到達するまで再帰的に有効化または無効化されます。以下のフラグは、RedrawWindow 関数の影響を受けるウィンドウを制御します。

フラグ 説明
RDW_ALLCHILDREN
子ウィンドウがある場合、それらを再描画操作に含めます。
RDW_NOCHILDREN
子ウィンドウがある場合、それらを再描画操作から除外します。

戻り値の型: BOOL

公式ドキュメント

RedrawWindow 関数は、ウィンドウのクライアント領域内で指定された四角形またはリージョンを更新します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。

解説(Remarks)

RedrawWindow を使用してデスクトップウィンドウの一部を無効化した場合、デスクトップウィンドウは WM_PAINT メッセージを受け取りません。デスクトップを再描画するには、アプリケーションは RDW_ERASE フラグを使用して WM_ERASEBKGND メッセージを生成します。

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

各言語での呼び出し定義

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

BOOL RedrawWindow(
    HWND hWnd,   // optional
    const RECT* lprcUpdate,   // optional
    HRGN hrgnUpdate,   // optional
    REDRAW_WINDOW_FLAGS flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool RedrawWindow(
    IntPtr hWnd,   // HWND optional
    IntPtr lprcUpdate,   // RECT* optional
    IntPtr hrgnUpdate,   // HRGN optional
    uint flags   // REDRAW_WINDOW_FLAGS
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function RedrawWindow(
    hWnd As IntPtr,   ' HWND optional
    lprcUpdate As IntPtr,   ' RECT* optional
    hrgnUpdate As IntPtr,   ' HRGN optional
    flags As UInteger   ' REDRAW_WINDOW_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hWnd : HWND optional
' lprcUpdate : RECT* optional
' hrgnUpdate : HRGN optional
' flags : REDRAW_WINDOW_FLAGS
Declare PtrSafe Function RedrawWindow Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal lprcUpdate As LongPtr, _
    ByVal hrgnUpdate As LongPtr, _
    ByVal flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RedrawWindow = ctypes.windll.user32.RedrawWindow
RedrawWindow.restype = wintypes.BOOL
RedrawWindow.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND optional
    ctypes.c_void_p,  # lprcUpdate : RECT* optional
    wintypes.HANDLE,  # hrgnUpdate : HRGN optional
    wintypes.DWORD,  # flags : REDRAW_WINDOW_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
RedrawWindow = Fiddle::Function.new(
  lib['RedrawWindow'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # lprcUpdate : RECT* optional
    Fiddle::TYPE_VOIDP,  # hrgnUpdate : HRGN optional
    -Fiddle::TYPE_INT,  # flags : REDRAW_WINDOW_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn RedrawWindow(
        hWnd: *mut core::ffi::c_void,  // HWND optional
        lprcUpdate: *const RECT,  // RECT* optional
        hrgnUpdate: *mut core::ffi::c_void,  // HRGN optional
        flags: u32  // REDRAW_WINDOW_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool RedrawWindow(IntPtr hWnd, IntPtr lprcUpdate, IntPtr hrgnUpdate, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_RedrawWindow' -Namespace Win32 -PassThru
# $api::RedrawWindow(hWnd, lprcUpdate, hrgnUpdate, flags)
#uselib "USER32.dll"
#func global RedrawWindow "RedrawWindow" sptr, sptr, sptr, sptr
; RedrawWindow hWnd, varptr(lprcUpdate), hrgnUpdate, flags   ; 戻り値は stat
; hWnd : HWND optional -> "sptr"
; lprcUpdate : RECT* optional -> "sptr"
; hrgnUpdate : HRGN optional -> "sptr"
; flags : REDRAW_WINDOW_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global RedrawWindow "RedrawWindow" sptr, var, sptr, int
; res = RedrawWindow(hWnd, lprcUpdate, hrgnUpdate, flags)
; hWnd : HWND optional -> "sptr"
; lprcUpdate : RECT* optional -> "var"
; hrgnUpdate : HRGN optional -> "sptr"
; flags : REDRAW_WINDOW_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL RedrawWindow(HWND hWnd, RECT* lprcUpdate, HRGN hrgnUpdate, REDRAW_WINDOW_FLAGS flags)
#uselib "USER32.dll"
#cfunc global RedrawWindow "RedrawWindow" intptr, var, intptr, int
; res = RedrawWindow(hWnd, lprcUpdate, hrgnUpdate, flags)
; hWnd : HWND optional -> "intptr"
; lprcUpdate : RECT* optional -> "var"
; hrgnUpdate : HRGN optional -> "intptr"
; flags : REDRAW_WINDOW_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procRedrawWindow = user32.NewProc("RedrawWindow")
)

// hWnd (HWND optional), lprcUpdate (RECT* optional), hrgnUpdate (HRGN optional), flags (REDRAW_WINDOW_FLAGS)
r1, _, err := procRedrawWindow.Call(
	uintptr(hWnd),
	uintptr(lprcUpdate),
	uintptr(hrgnUpdate),
	uintptr(flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function RedrawWindow(
  hWnd: THandle;   // HWND optional
  lprcUpdate: Pointer;   // RECT* optional
  hrgnUpdate: THandle;   // HRGN optional
  flags: DWORD   // REDRAW_WINDOW_FLAGS
): BOOL; stdcall;
  external 'USER32.dll' name 'RedrawWindow';
result := DllCall("USER32\RedrawWindow"
    , "Ptr", hWnd   ; HWND optional
    , "Ptr", lprcUpdate   ; RECT* optional
    , "Ptr", hrgnUpdate   ; HRGN optional
    , "UInt", flags   ; REDRAW_WINDOW_FLAGS
    , "Int")   ; return: BOOL
●RedrawWindow(hWnd, lprcUpdate, hrgnUpdate, flags) = DLL("USER32.dll", "bool RedrawWindow(void*, void*, void*, dword)")
# 呼び出し: RedrawWindow(hWnd, lprcUpdate, hrgnUpdate, flags)
# hWnd : HWND optional -> "void*"
# lprcUpdate : RECT* optional -> "void*"
# hrgnUpdate : HRGN optional -> "void*"
# flags : REDRAW_WINDOW_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef RedrawWindowNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Uint32);
typedef RedrawWindowDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int);
final RedrawWindow = DynamicLibrary.open('USER32.dll')
    .lookupFunction<RedrawWindowNative, RedrawWindowDart>('RedrawWindow');
// hWnd : HWND optional -> Pointer<Void>
// lprcUpdate : RECT* optional -> Pointer<Void>
// hrgnUpdate : HRGN optional -> Pointer<Void>
// flags : REDRAW_WINDOW_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RedrawWindow(
  hWnd: THandle;   // HWND optional
  lprcUpdate: Pointer;   // RECT* optional
  hrgnUpdate: THandle;   // HRGN optional
  flags: DWORD   // REDRAW_WINDOW_FLAGS
): BOOL; stdcall;
  external 'USER32.dll' name 'RedrawWindow';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RedrawWindow"
  c_RedrawWindow :: Ptr () -> Ptr () -> Ptr () -> Word32 -> IO CInt
-- hWnd : HWND optional -> Ptr ()
-- lprcUpdate : RECT* optional -> Ptr ()
-- hrgnUpdate : HRGN optional -> Ptr ()
-- flags : REDRAW_WINDOW_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let redrawwindow =
  foreign "RedrawWindow"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* hWnd : HWND optional -> (ptr void) *)
(* lprcUpdate : RECT* optional -> (ptr void) *)
(* hrgnUpdate : HRGN optional -> (ptr void) *)
(* flags : REDRAW_WINDOW_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("RedrawWindow" redraw-window :convention :stdcall) :int32
  (h-wnd :pointer)   ; HWND optional
  (lprc-update :pointer)   ; RECT* optional
  (hrgn-update :pointer)   ; HRGN optional
  (flags :uint32))   ; REDRAW_WINDOW_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RedrawWindow = Win32::API::More->new('USER32',
    'BOOL RedrawWindow(HANDLE hWnd, LPVOID lprcUpdate, HANDLE hrgnUpdate, DWORD flags)');
# my $ret = $RedrawWindow->Call($hWnd, $lprcUpdate, $hrgnUpdate, $flags);
# hWnd : HWND optional -> HANDLE
# lprcUpdate : RECT* optional -> LPVOID
# hrgnUpdate : HRGN optional -> HANDLE
# flags : REDRAW_WINDOW_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型