ホーム › Graphics.Gdi › ExcludeUpdateRgn
ExcludeUpdateRgn
関数デバイスコンテキストのクリップ領域から更新領域を除外する。
シグネチャ
// USER32.dll
#include <windows.h>
INT ExcludeUpdateRgn(
HDC hDC,
HWND hWnd
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hDC | HDC | in | クリッピング領域に関連付けられたデバイスコンテキストへのハンドルです。 |
| hWnd | HWND | in | 更新するウィンドウへのハンドルです。 |
戻り値の型: INT
公式ドキュメント
ExcludeUpdateRgn 関数は、ウィンドウ内の更新された領域をクリッピング領域から除外することで、ウィンドウの無効な領域への描画を防止します。
戻り値
戻り値は、除外された領域の複雑さを示し、次のいずれかの値になります。
| 値 | 意味 |
|---|---|
| COMPLEXREGION | 領域は複数の四角形で構成されています。 |
| ERROR | エラーが発生しました。 |
| NULLREGION | 領域は空です。 |
| SIMPLEREGION | 領域は単一の四角形です。 |
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// USER32.dll
#include <windows.h>
INT ExcludeUpdateRgn(
HDC hDC,
HWND hWnd
);[DllImport("USER32.dll", ExactSpelling = true)]
static extern int ExcludeUpdateRgn(
IntPtr hDC, // HDC
IntPtr hWnd // HWND
);<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function ExcludeUpdateRgn(
hDC As IntPtr, ' HDC
hWnd As IntPtr ' HWND
) As Integer
End Function' hDC : HDC
' hWnd : HWND
Declare PtrSafe Function ExcludeUpdateRgn Lib "user32" ( _
ByVal hDC As LongPtr, _
ByVal hWnd As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ExcludeUpdateRgn = ctypes.windll.user32.ExcludeUpdateRgn
ExcludeUpdateRgn.restype = ctypes.c_int
ExcludeUpdateRgn.argtypes = [
wintypes.HANDLE, # hDC : HDC
wintypes.HANDLE, # hWnd : HWND
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('USER32.dll')
ExcludeUpdateRgn = Fiddle::Function.new(
lib['ExcludeUpdateRgn'],
[
Fiddle::TYPE_VOIDP, # hDC : HDC
Fiddle::TYPE_VOIDP, # hWnd : HWND
],
Fiddle::TYPE_INT)#[link(name = "user32")]
extern "system" {
fn ExcludeUpdateRgn(
hDC: *mut core::ffi::c_void, // HDC
hWnd: *mut core::ffi::c_void // HWND
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("USER32.dll")]
public static extern int ExcludeUpdateRgn(IntPtr hDC, IntPtr hWnd);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_ExcludeUpdateRgn' -Namespace Win32 -PassThru
# $api::ExcludeUpdateRgn(hDC, hWnd)#uselib "USER32.dll"
#func global ExcludeUpdateRgn "ExcludeUpdateRgn" sptr, sptr
; ExcludeUpdateRgn hDC, hWnd ; 戻り値は stat
; hDC : HDC -> "sptr"
; hWnd : HWND -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "USER32.dll"
#cfunc global ExcludeUpdateRgn "ExcludeUpdateRgn" sptr, sptr
; res = ExcludeUpdateRgn(hDC, hWnd)
; hDC : HDC -> "sptr"
; hWnd : HWND -> "sptr"; INT ExcludeUpdateRgn(HDC hDC, HWND hWnd)
#uselib "USER32.dll"
#cfunc global ExcludeUpdateRgn "ExcludeUpdateRgn" intptr, intptr
; res = ExcludeUpdateRgn(hDC, hWnd)
; hDC : HDC -> "intptr"
; hWnd : HWND -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
user32 = windows.NewLazySystemDLL("USER32.dll")
procExcludeUpdateRgn = user32.NewProc("ExcludeUpdateRgn")
)
// hDC (HDC), hWnd (HWND)
r1, _, err := procExcludeUpdateRgn.Call(
uintptr(hDC),
uintptr(hWnd),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // INTfunction ExcludeUpdateRgn(
hDC: THandle; // HDC
hWnd: THandle // HWND
): Integer; stdcall;
external 'USER32.dll' name 'ExcludeUpdateRgn';result := DllCall("USER32\ExcludeUpdateRgn"
, "Ptr", hDC ; HDC
, "Ptr", hWnd ; HWND
, "Int") ; return: INT●ExcludeUpdateRgn(hDC, hWnd) = DLL("USER32.dll", "int ExcludeUpdateRgn(void*, void*)")
# 呼び出し: ExcludeUpdateRgn(hDC, hWnd)
# hDC : HDC -> "void*"
# hWnd : HWND -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "user32" fn ExcludeUpdateRgn(
hDC: ?*anyopaque, // HDC
hWnd: ?*anyopaque // HWND
) callconv(std.os.windows.WINAPI) i32;proc ExcludeUpdateRgn(
hDC: pointer, # HDC
hWnd: pointer # HWND
): int32 {.importc: "ExcludeUpdateRgn", stdcall, dynlib: "USER32.dll".}pragma(lib, "user32");
extern(Windows)
int ExcludeUpdateRgn(
void* hDC, // HDC
void* hWnd // HWND
);ccall((:ExcludeUpdateRgn, "USER32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}),
hDC, hWnd)
# hDC : HDC -> Ptr{Cvoid}
# hWnd : HWND -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t ExcludeUpdateRgn(
void* hDC,
void* hWnd);
]]
local user32 = ffi.load("user32")
-- user32.ExcludeUpdateRgn(hDC, hWnd)
-- hDC : HDC
-- hWnd : HWND
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const ExcludeUpdateRgn = lib.func('__stdcall', 'ExcludeUpdateRgn', 'int32_t', ['void *', 'void *']);
// ExcludeUpdateRgn(hDC, hWnd)
// hDC : HDC -> 'void *'
// hWnd : HWND -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("USER32.dll", {
ExcludeUpdateRgn: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.ExcludeUpdateRgn(hDC, hWnd)
// hDC : HDC -> "pointer"
// hWnd : HWND -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ExcludeUpdateRgn(
void* hDC,
void* hWnd);
C, "USER32.dll");
// $ffi->ExcludeUpdateRgn(hDC, hWnd);
// hDC : HDC
// hWnd : HWND
// 構造体/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);
int ExcludeUpdateRgn(
Pointer hDC, // HDC
Pointer hWnd // HWND
);
}@[Link("user32")]
lib LibUSER32
fun ExcludeUpdateRgn = ExcludeUpdateRgn(
hDC : Void*, # HDC
hWnd : Void* # HWND
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ExcludeUpdateRgnNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef ExcludeUpdateRgnDart = int Function(Pointer<Void>, Pointer<Void>);
final ExcludeUpdateRgn = DynamicLibrary.open('USER32.dll')
.lookupFunction<ExcludeUpdateRgnNative, ExcludeUpdateRgnDart>('ExcludeUpdateRgn');
// hDC : HDC -> Pointer<Void>
// hWnd : HWND -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function ExcludeUpdateRgn(
hDC: THandle; // HDC
hWnd: THandle // HWND
): Integer; stdcall;
external 'USER32.dll' name 'ExcludeUpdateRgn';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ExcludeUpdateRgn"
c_ExcludeUpdateRgn :: Ptr () -> Ptr () -> IO Int32
-- hDC : HDC -> Ptr ()
-- hWnd : HWND -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let excludeupdatergn =
foreign "ExcludeUpdateRgn"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* hDC : HDC -> (ptr void) *)
(* hWnd : HWND -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)
(cffi:defcfun ("ExcludeUpdateRgn" exclude-update-rgn :convention :stdcall) :int32
(h-dc :pointer) ; HDC
(h-wnd :pointer)) ; HWND
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ExcludeUpdateRgn = Win32::API::More->new('USER32',
'int ExcludeUpdateRgn(HANDLE hDC, HANDLE hWnd)');
# my $ret = $ExcludeUpdateRgn->Call($hDC, $hWnd);
# hDC : HDC -> HANDLE
# hWnd : HWND -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f BeginPaint — ウィンドウの描画を開始し描画用デバイスコンテキストを取得する。
- f GetUpdateRect — ウィンドウの更新が必要な領域の外接矩形を取得する。
- f GetUpdateRgn — ウィンドウの更新が必要な領域をリージョンとして取得する。
- f UpdateWindow — 更新領域があればウィンドウへ即座にWM_PAINTを送り再描画する。