ホーム › Graphics.Gdi › EnumDisplayMonitors

EnumDisplayMonitors

関数

表示モニタの集合をコールバックで列挙する。

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

シグネチャ

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

BOOL EnumDisplayMonitors(
    HDC hdc,   // optional
    RECT* lprcClip,   // optional
    MONITORENUMPROC lpfnEnum,
    LPARAM dwData
);

パラメーター

名前	型	方向	説明
hdc	HDC	inoptional	対象となる可視領域を定義するディスプレイデバイスコンテキストへのハンドルです。このパラメーターが NULL の場合、コールバック関数に渡される hdcMonitor パラメーターも NULL となり、対象となる可視領域はデスクトップ上のすべてのディスプレイを包含する仮想スクリーンになります。
lprcClip	RECT*	inoptional	クリッピング矩形を指定する RECT 構造体へのポインターです。対象領域は、クリッピング矩形と hdc で指定された可視領域との交差部分です。 hdc が非 NULL の場合、クリッピング矩形の座標は hdc の原点を基準とします。hdc が NULL の場合、座標は仮想スクリーン座標になります。 hdc で指定された領域をクリッピングしない場合、このパラメーターは NULL にできます。
lpfnEnum	MONITORENUMPROC	in	アプリケーション定義のコールバック関数 MonitorEnumProc へのポインターです。
dwData	LPARAM	in	EnumDisplayMonitors が MonitorEnumProc 関数に直接渡す、アプリケーション定義のデータです。

戻り値の型: BOOL

公式ドキュメント

EnumDisplayMonitors 関数は、指定したクリッピング矩形とデバイスコンテキストの可視領域との交差によって形成される領域に重なるディスプレイモニター(ミラードライバーに関連付けられた不可視の疑似モニターを含む)を列挙します。EnumDisplayMonitors は、列挙されたモニターごとに 1 回、アプリケーション定義の MonitorEnumProc コールバック関数を呼び出します。なお、GetSystemMetrics (SM_CMONITORS) はディスプレイモニターのみをカウントする点に注意してください。

戻り値

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

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

解説(Remarks)

EnumDisplayMonitors 関数を呼び出す理由は 2 つあります。

複数のディスプレイモニターにまたがるデバイスコンテキストに最適な形で描画したいが、それらのモニターが異なるカラーフォーマットを持つ場合。
1 つ以上のディスプレイモニターのハンドルと位置を表す矩形を取得したい場合。

システム内のすべてのディスプレイモニターが同じカラーフォーマットを共有しているかどうかを判定するには、GetSystemMetrics (SM_SAMEDISPLAYFORMAT) を呼び出します。

ウィンドウが異なるカラーフォーマットを持つディスプレイモニターにまたがる場合でも、EnumDisplayMonitors 関数を使用する必要はありません。画面全体がプライマリモニターのカラープロパティを持つものと想定して描画を続行できます。ウィンドウは問題なく表示されます。EnumDisplayMonitors は、それをより良く見せるための手段にすぎません。

hdc パラメーターを NULL に設定すると、EnumDisplayMonitors 関数を使用して 1 つ以上のディスプレイモニターのハンドルと位置を表す矩形を取得できます。次の表は、hdc と lprcClip の NULL と非 NULL の 4 通りの組み合わせが EnumDisplayMonitors 関数の動作にどのように影響するかを示しています。

hdc	lprcRect	EnumDisplayMonitors の動作
NULL	NULL	すべてのディスプレイモニターを列挙します。コールバック関数は NULL の HDC を受け取ります。
NULL	非 NULL	クリッピング矩形に重なるすべてのディスプレイモニターを列挙します。クリッピング矩形には仮想スクリーン座標を使用します。コールバック関数は NULL の HDC を受け取ります。
非 NULL	NULL	デバイスコンテキストの可視領域に重なるすべてのディスプレイモニターを列挙します。コールバック関数は、特定のディスプレイモニターに対する DC のハンドルを受け取ります。
非 NULL	非 NULL	デバイスコンテキストの可視領域とクリッピング矩形の両方に重なるすべてのディスプレイモニターを列挙します。クリッピング矩形にはデバイスコンテキスト座標を使用します。コールバック関数は、特定のディスプレイモニターに対する DC のハンドルを受け取ります。

例

WM_PAINT メッセージに応答して各モニターの機能を活用して描画するには、ウィンドウプロシージャで次のようなコードを使用できます。


case WM_PAINT:
  hdc = BeginPaint(hwnd, &ps);
  EnumDisplayMonitors(hdc, NULL, MyPaintEnumProc, 0);
  EndPaint(hwnd, &ps);

各モニターの機能を活用してウィンドウの上半分を描画するには、次のようなコードを使用できます。


GetClientRect(hwnd, &rc);
rc.bottom = (rc.bottom - rc.top) / 2;
hdc = GetDC(hwnd);
EnumDisplayMonitors(hdc, &rc, MyPaintEnumProc, 0);
ReleaseDC(hwnd, hdc);

各ディスプレイモニターに最適な形で仮想スクリーン全体を描画するには、次のようなコードを使用できます。


hdc = GetDC(NULL);
EnumDisplayMonitors(hdc, NULL, MyPaintScreenEnumProc, 0);
ReleaseDC(NULL, hdc);

すべてのディスプレイモニターに関する情報を取得するには、次のようなコードを使用します。


EnumDisplayMonitors(NULL, NULL, MyInfoEnumProc, 0);

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

各言語での呼び出し定義

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

BOOL EnumDisplayMonitors(
    HDC hdc,   // optional
    RECT* lprcClip,   // optional
    MONITORENUMPROC lpfnEnum,
    LPARAM dwData
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", ExactSpelling = true)]
static extern bool EnumDisplayMonitors(
    IntPtr hdc,   // HDC optional
    IntPtr lprcClip,   // RECT* optional
    IntPtr lpfnEnum,   // MONITORENUMPROC
    IntPtr dwData   // LPARAM
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function EnumDisplayMonitors(
    hdc As IntPtr,   ' HDC optional
    lprcClip As IntPtr,   ' RECT* optional
    lpfnEnum As IntPtr,   ' MONITORENUMPROC
    dwData As IntPtr   ' LPARAM
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hdc : HDC optional
' lprcClip : RECT* optional
' lpfnEnum : MONITORENUMPROC
' dwData : LPARAM
Declare PtrSafe Function EnumDisplayMonitors Lib "user32" ( _
    ByVal hdc As LongPtr, _
    ByVal lprcClip As LongPtr, _
    ByVal lpfnEnum As LongPtr, _
    ByVal dwData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumDisplayMonitors = ctypes.windll.user32.EnumDisplayMonitors
EnumDisplayMonitors.restype = wintypes.BOOL
EnumDisplayMonitors.argtypes = [
    wintypes.HANDLE,  # hdc : HDC optional
    ctypes.c_void_p,  # lprcClip : RECT* optional
    ctypes.c_void_p,  # lpfnEnum : MONITORENUMPROC
    ctypes.c_ssize_t,  # dwData : LPARAM
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumDisplayMonitors = Fiddle::Function.new(
  lib['EnumDisplayMonitors'],
  [
    Fiddle::TYPE_VOIDP,  # hdc : HDC optional
    Fiddle::TYPE_VOIDP,  # lprcClip : RECT* optional
    Fiddle::TYPE_VOIDP,  # lpfnEnum : MONITORENUMPROC
    Fiddle::TYPE_INTPTR_T,  # dwData : LPARAM
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn EnumDisplayMonitors(
        hdc: *mut core::ffi::c_void,  // HDC optional
        lprcClip: *mut RECT,  // RECT* optional
        lpfnEnum: *const core::ffi::c_void,  // MONITORENUMPROC
        dwData: isize  // LPARAM
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll")]
public static extern bool EnumDisplayMonitors(IntPtr hdc, IntPtr lprcClip, IntPtr lpfnEnum, IntPtr dwData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumDisplayMonitors' -Namespace Win32 -PassThru
# $api::EnumDisplayMonitors(hdc, lprcClip, lpfnEnum, dwData)

#uselib "USER32.dll"
#func global EnumDisplayMonitors "EnumDisplayMonitors" sptr, sptr, sptr, sptr
; EnumDisplayMonitors hdc, varptr(lprcClip), lpfnEnum, dwData   ; 戻り値は stat
; hdc : HDC optional -> "sptr"
; lprcClip : RECT* optional -> "sptr"
; lpfnEnum : MONITORENUMPROC -> "sptr"
; dwData : LPARAM -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global EnumDisplayMonitors "EnumDisplayMonitors" sptr, var, sptr, sptr
; res = EnumDisplayMonitors(hdc, lprcClip, lpfnEnum, dwData)
; hdc : HDC optional -> "sptr"
; lprcClip : RECT* optional -> "var"
; lpfnEnum : MONITORENUMPROC -> "sptr"
; dwData : LPARAM -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global EnumDisplayMonitors "EnumDisplayMonitors" sptr, sptr, sptr, sptr
; res = EnumDisplayMonitors(hdc, varptr(lprcClip), lpfnEnum, dwData)
; hdc : HDC optional -> "sptr"
; lprcClip : RECT* optional -> "sptr"
; lpfnEnum : MONITORENUMPROC -> "sptr"
; dwData : LPARAM -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。