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

GetDCEx

関数
クリップ領域やフラグを指定してウィンドウのデバイスコンテキストを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HDC GetDCEx(
    HWND hWnd,   // optional
    HRGN hrgnClip,   // optional
    GET_DCX_FLAGS flags
);

パラメーター

名前方向説明
hWndHWNDinoptionalDC を取得する対象ウィンドウのハンドル。この値が NULL の場合、GetDCEx は画面全体の DC を取得します。
hrgnClipHRGNinoptionalDC の可視領域と組み合わせることができるクリッピング領域。flags の値が DCX_INTERSECTRGN または DCX_EXCLUDERGN の場合、オペレーティングシステムがこの領域の所有権を取得し、不要になった時点で自動的に削除します。この場合、GetDCEx の呼び出しが成功した後、アプリケーションはこの領域を使用したり削除したりしてはなりません。
flagsGET_DCX_FLAGSin

DC の作成方法を指定します。このパラメーターには、次の値を 1 つ以上指定できます。

意味
DCX_WINDOW
クライアント矩形ではなく、ウィンドウ矩形に対応する DC を返します。
DCX_CACHE
OWNDC または CLASSDC ウィンドウではなく、キャッシュから DC を返します。実質的に CS_OWNDC および CS_CLASSDC を上書きします。
DCX_PARENTCLIP
親ウィンドウの可視領域を使用します。親ウィンドウの WS_CLIPCHILDREN および CS_PARENTDC スタイルビットは無視されます。原点は hWnd で識別されるウィンドウの左上隅に設定されます。
DCX_CLIPSIBLINGS
hWnd で識別されるウィンドウより上にあるすべての兄弟ウィンドウの可視領域を除外します。
DCX_CLIPCHILDREN
hWnd で識別されるウィンドウより下にあるすべての子ウィンドウの可視領域を除外します。
DCX_NORESETATTRS
このフラグは無視されます。
DCX_LOCKWINDOWUPDATE
このウィンドウを通常は除外する LockWindowUpdate の呼び出しが有効な場合でも、描画を許可します。トラッキング中の描画に使用されます。
DCX_EXCLUDERGN
hrgnClip で識別されるクリッピング領域が、返される DC の可視領域から除外されます。
DCX_INTERSECTRGN
hrgnClip で識別されるクリッピング領域が、返される DC の可視領域と交差されます。
DCX_INTERSECTUPDATE
予約済み。使用しないでください。
DCX_VALIDATE
予約済み。使用しないでください。

戻り値の型: HDC

公式ドキュメント

GetDCEx 関数は、指定したウィンドウのクライアント領域、または画面全体のデバイスコンテキスト (DC) のハンドルを取得します。

戻り値

関数が成功した場合、戻り値は指定したウィンドウの DC のハンドルです。

関数が失敗した場合、戻り値は NULL です。hWnd パラメーターに無効な値を指定すると、関数は失敗します。

解説(Remarks)

表示用 DC がウィンドウクラスに属している場合を除き、描画後に DC を解放するために ReleaseDC 関数を呼び出す必要があります。また、ReleaseDCGetDCEx を呼び出したのと同じスレッドから呼び出す必要があります。DC の数は、利用可能なメモリによってのみ制限されます。

クラスの登録時に WNDCLASS 構造体のスタイルとして CS_CLASSDCCS_OWNDC、または CS_PARENTDC が指定されていた場合、この関数はウィンドウのクラスに属する DC のハンドルを返します。

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

各言語での呼び出し定義

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

HDC GetDCEx(
    HWND hWnd,   // optional
    HRGN hrgnClip,   // optional
    GET_DCX_FLAGS flags
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern IntPtr GetDCEx(
    IntPtr hWnd,   // HWND optional
    IntPtr hrgnClip,   // HRGN optional
    uint flags   // GET_DCX_FLAGS
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetDCEx(
    hWnd As IntPtr,   ' HWND optional
    hrgnClip As IntPtr,   ' HRGN optional
    flags As UInteger   ' GET_DCX_FLAGS
) As IntPtr
End Function
' hWnd : HWND optional
' hrgnClip : HRGN optional
' flags : GET_DCX_FLAGS
Declare PtrSafe Function GetDCEx Lib "user32" ( _
    ByVal hWnd As LongPtr, _
    ByVal hrgnClip As LongPtr, _
    ByVal flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDCEx = ctypes.windll.user32.GetDCEx
GetDCEx.restype = ctypes.c_void_p
GetDCEx.argtypes = [
    wintypes.HANDLE,  # hWnd : HWND optional
    wintypes.HANDLE,  # hrgnClip : HRGN optional
    wintypes.DWORD,  # flags : GET_DCX_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetDCEx = Fiddle::Function.new(
  lib['GetDCEx'],
  [
    Fiddle::TYPE_VOIDP,  # hWnd : HWND optional
    Fiddle::TYPE_VOIDP,  # hrgnClip : HRGN optional
    -Fiddle::TYPE_INT,  # flags : GET_DCX_FLAGS
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn GetDCEx(
        hWnd: *mut core::ffi::c_void,  // HWND optional
        hrgnClip: *mut core::ffi::c_void,  // HRGN optional
        flags: u32  // GET_DCX_FLAGS
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern IntPtr GetDCEx(IntPtr hWnd, IntPtr hrgnClip, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetDCEx' -Namespace Win32 -PassThru
# $api::GetDCEx(hWnd, hrgnClip, flags)
#uselib "USER32.dll"
#func global GetDCEx "GetDCEx" sptr, sptr, sptr
; GetDCEx hWnd, hrgnClip, flags   ; 戻り値は stat
; hWnd : HWND optional -> "sptr"
; hrgnClip : HRGN optional -> "sptr"
; flags : GET_DCX_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global GetDCEx "GetDCEx" sptr, sptr, int
; res = GetDCEx(hWnd, hrgnClip, flags)
; hWnd : HWND optional -> "sptr"
; hrgnClip : HRGN optional -> "sptr"
; flags : GET_DCX_FLAGS -> "int"
; HDC GetDCEx(HWND hWnd, HRGN hrgnClip, GET_DCX_FLAGS flags)
#uselib "USER32.dll"
#cfunc global GetDCEx "GetDCEx" intptr, intptr, int
; res = GetDCEx(hWnd, hrgnClip, flags)
; hWnd : HWND optional -> "intptr"
; hrgnClip : HRGN optional -> "intptr"
; flags : GET_DCX_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetDCEx = user32.NewProc("GetDCEx")
)

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

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

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

foreign import stdcall safe "GetDCEx"
  c_GetDCEx :: Ptr () -> Ptr () -> Word32 -> IO (Ptr ())
-- hWnd : HWND optional -> Ptr ()
-- hrgnClip : HRGN optional -> Ptr ()
-- flags : GET_DCX_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdcex =
  foreign "GetDCEx"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning (ptr void))
(* hWnd : HWND optional -> (ptr void) *)
(* hrgnClip : HRGN optional -> (ptr void) *)
(* flags : GET_DCX_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 ("GetDCEx" get-dcex :convention :stdcall) :pointer
  (h-wnd :pointer)   ; HWND optional
  (hrgn-clip :pointer)   ; HRGN optional
  (flags :uint32))   ; GET_DCX_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDCEx = Win32::API::More->new('USER32',
    'HANDLE GetDCEx(HANDLE hWnd, HANDLE hrgnClip, DWORD flags)');
# my $ret = $GetDCEx->Call($hWnd, $hrgnClip, $flags);
# hWnd : HWND optional -> HANDLE
# hrgnClip : HRGN optional -> HANDLE
# flags : GET_DCX_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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