ホーム › Devices.Display › GetPhysicalMonitorsFromHMONITOR

GetPhysicalMonitorsFromHMONITOR

関数

HMONITORから物理モニタのハンドル配列を取得する。

DLLdxva2.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetPhysicalMonitorsFromHMONITOR(
    HMONITOR hMonitor,
    DWORD dwPhysicalMonitorArraySize,
    PHYSICAL_MONITOR* pPhysicalMonitorArray
);

パラメーター

名前	型	方向	説明
hMonitor	HMONITOR	in	モニターハンドルです。モニターハンドルは、グラフィックスデバイスインターフェイス (GDI) の一部である EnumDisplayMonitors や MonitorFromWindow など、複数のマルチディスプレイモニター関数から返されます。
dwPhysicalMonitorArraySize	DWORD	in	pPhysicalMonitorArray の要素数です。配列に必要なサイズを取得するには、GetNumberOfPhysicalMonitorsFromHMONITOR を呼び出してください。
pPhysicalMonitorArray	PHYSICAL_MONITOR*	out	PHYSICAL_MONITOR 構造体の配列へのポインターです。呼び出し側が配列を割り当てる必要があります。

戻り値の型: BOOL

公式ドキュメント

HMONITOR モニターハンドルに関連付けられた物理モニターを取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出してください。

解説(Remarks)

1 つの HMONITOR ハンドルは、複数の物理モニターに関連付けられる場合があります。この関数は、各物理モニターに対するハンドルとテキストによる説明を返します。

モニターハンドルの使用を終えたら、pPhysicalMonitorArray 配列を DestroyPhysicalMonitors 関数に渡してハンドルを閉じてください。

例


HMONITOR hMonitor = NULL;
DWORD cPhysicalMonitors;
LPPHYSICAL_MONITOR pPhysicalMonitors = NULL;

// モニターハンドルを取得します。
hMonitor = MonitorFromWindow(hWnd, MONITOR_DEFAULTTOPRIMARY);

// 物理モニターの数を取得します。
BOOL bSuccess = GetNumberOfPhysicalMonitorsFromHMONITOR(
  hMonitor, 
  &cPhysicalMonitors
   );

if (bSuccess)
{
    // PHYSICAL_MONITOR 構造体の配列を割り当てます。
    pPhysicalMonitors = (LPPHYSICAL_MONITOR)malloc(
        cPhysicalMonitors* sizeof(PHYSICAL_MONITOR));

    if (pPhysicalMonitors != NULL)
    {
        // 配列を取得します。
        bSuccess = GetPhysicalMonitorsFromHMONITOR(
            hMonitor, cPhysicalMonitors, pPhysicalMonitors);

       // モニターハンドルを使用します (省略)。

        // モニターハンドルを閉じます。
        bSuccess = DestroyPhysicalMonitors(
            cPhysicalMonitors, 
            pPhysicalMonitors);

        // 配列を解放します。
        free(pPhysicalMonitors);
    }
}

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

各言語での呼び出し定義

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

BOOL GetPhysicalMonitorsFromHMONITOR(
    HMONITOR hMonitor,
    DWORD dwPhysicalMonitorArraySize,
    PHYSICAL_MONITOR* pPhysicalMonitorArray
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dxva2.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetPhysicalMonitorsFromHMONITOR(
    IntPtr hMonitor,   // HMONITOR
    uint dwPhysicalMonitorArraySize,   // DWORD
    IntPtr pPhysicalMonitorArray   // PHYSICAL_MONITOR* out
);

<DllImport("dxva2.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetPhysicalMonitorsFromHMONITOR(
    hMonitor As IntPtr,   ' HMONITOR
    dwPhysicalMonitorArraySize As UInteger,   ' DWORD
    pPhysicalMonitorArray As IntPtr   ' PHYSICAL_MONITOR* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hMonitor : HMONITOR
' dwPhysicalMonitorArraySize : DWORD
' pPhysicalMonitorArray : PHYSICAL_MONITOR* out
Declare PtrSafe Function GetPhysicalMonitorsFromHMONITOR Lib "dxva2" ( _
    ByVal hMonitor As LongPtr, _
    ByVal dwPhysicalMonitorArraySize As Long, _
    ByVal pPhysicalMonitorArray As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetPhysicalMonitorsFromHMONITOR = ctypes.windll.dxva2.GetPhysicalMonitorsFromHMONITOR
GetPhysicalMonitorsFromHMONITOR.restype = wintypes.BOOL
GetPhysicalMonitorsFromHMONITOR.argtypes = [
    wintypes.HANDLE,  # hMonitor : HMONITOR
    wintypes.DWORD,  # dwPhysicalMonitorArraySize : DWORD
    ctypes.c_void_p,  # pPhysicalMonitorArray : PHYSICAL_MONITOR* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dxva2.dll')
GetPhysicalMonitorsFromHMONITOR = Fiddle::Function.new(
  lib['GetPhysicalMonitorsFromHMONITOR'],
  [
    Fiddle::TYPE_VOIDP,  # hMonitor : HMONITOR
    -Fiddle::TYPE_INT,  # dwPhysicalMonitorArraySize : DWORD
    Fiddle::TYPE_VOIDP,  # pPhysicalMonitorArray : PHYSICAL_MONITOR* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dxva2")]
extern "system" {
    fn GetPhysicalMonitorsFromHMONITOR(
        hMonitor: *mut core::ffi::c_void,  // HMONITOR
        dwPhysicalMonitorArraySize: u32,  // DWORD
        pPhysicalMonitorArray: *mut PHYSICAL_MONITOR  // PHYSICAL_MONITOR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("dxva2.dll", SetLastError = true)]
public static extern bool GetPhysicalMonitorsFromHMONITOR(IntPtr hMonitor, uint dwPhysicalMonitorArraySize, IntPtr pPhysicalMonitorArray);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dxva2_GetPhysicalMonitorsFromHMONITOR' -Namespace Win32 -PassThru
# $api::GetPhysicalMonitorsFromHMONITOR(hMonitor, dwPhysicalMonitorArraySize, pPhysicalMonitorArray)

#uselib "dxva2.dll"
#func global GetPhysicalMonitorsFromHMONITOR "GetPhysicalMonitorsFromHMONITOR" sptr, sptr, sptr
; GetPhysicalMonitorsFromHMONITOR hMonitor, dwPhysicalMonitorArraySize, varptr(pPhysicalMonitorArray)   ; 戻り値は stat
; hMonitor : HMONITOR -> "sptr"
; dwPhysicalMonitorArraySize : DWORD -> "sptr"
; pPhysicalMonitorArray : PHYSICAL_MONITOR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dxva2.dll"
#cfunc global GetPhysicalMonitorsFromHMONITOR "GetPhysicalMonitorsFromHMONITOR" sptr, int, var
; res = GetPhysicalMonitorsFromHMONITOR(hMonitor, dwPhysicalMonitorArraySize, pPhysicalMonitorArray)
; hMonitor : HMONITOR -> "sptr"
; dwPhysicalMonitorArraySize : DWORD -> "int"
; pPhysicalMonitorArray : PHYSICAL_MONITOR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dxva2.dll"
#cfunc global GetPhysicalMonitorsFromHMONITOR "GetPhysicalMonitorsFromHMONITOR" sptr, int, sptr
; res = GetPhysicalMonitorsFromHMONITOR(hMonitor, dwPhysicalMonitorArraySize, varptr(pPhysicalMonitorArray))
; hMonitor : HMONITOR -> "sptr"
; dwPhysicalMonitorArraySize : DWORD -> "int"
; pPhysicalMonitorArray : PHYSICAL_MONITOR* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。