ホーム › Graphics.Gdi › EnumDisplayDevicesW

EnumDisplayDevicesW

関数

システムのディスプレイデバイス情報を列挙する(Unicode版)。

DLLUSER32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDisplayDevicesW(
    LPCWSTR lpDevice,   // optional
    DWORD iDevNum,
    DISPLAY_DEVICEW* lpDisplayDevice,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
lpDevice	LPCWSTR	inoptional	デバイス名へのポインターです。NULL の場合、関数は iDevNum に基づいて、マシン上のディスプレイアダプターに関する情報を返します。詳細については、「Remarks」を参照してください。
iDevNum	DWORD	in	対象とする表示デバイスを指定するインデックス値です。オペレーティングシステムは、現在のセッション内の各表示デバイスをインデックス値で識別します。インデックス値は 0 から始まる連続した整数です。たとえば、現在のセッションに 3 つの表示デバイスがある場合、それらはインデックス値 0、1、2 で指定されます。
lpDisplayDevice	DISPLAY_DEVICEW*	inout	iDevNum で指定された表示デバイスに関する情報を受け取る DISPLAY_DEVICE 構造体へのポインターです。 EnumDisplayDevices を呼び出す前に、DISPLAY_DEVICE の cb メンバーを DISPLAY_DEVICE のサイズ (バイト単位) に初期化しておく必要があります。
dwFlags	DWORD	in	オペレーティングシステムによってモニターごとに登録される GUID_DEVINTERFACE_MONITOR のデバイスインターフェイス名を取得するには、このフラグに EDD_GET_DEVICE_INTERFACE_NAME (0x00000001) を設定します。値は、lpDisplayDevice で返される DISPLAY_DEVICE 構造体の DeviceID メンバーに格納されます。取得したデバイスインターフェイス名は SetupAPI 関数で使用でき、GDI モニターデバイスと SetupAPI モニターデバイスを結び付ける役割を果たします。

戻り値の型: BOOL

公式ドキュメント

EnumDisplayDevices 関数は、現在のセッションにおける表示デバイスに関する情報を取得します。(Unicode)

戻り値

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

関数が失敗した場合、戻り値は 0 です。iDevNum が最大のデバイスインデックスを超えている場合、関数は失敗します。

解説(Remarks)

現在のセッション内のすべての表示デバイスを照会するには、iDevNum を 0 に設定して開始し、関数が失敗するまで iDevNum をインクリメントしながら、この関数をループ内で呼び出します。デスクトップ内のすべての表示デバイスを選択するには、DISPLAY_DEVICE 構造体に DISPLAY_DEVICE_ATTACHED_TO_DESKTOP フラグが設定されている表示デバイスのみを使用します。

ディスプレイアダプターに関する情報を取得するには、lpDevice を NULL に設定して EnumDisplayDevices を呼び出します。たとえば、DISPLAY_DEVICE.DeviceString にはアダプター名が格納されます。

ディスプレイモニターに関する情報を取得するには、まず lpDevice を NULL に設定して EnumDisplayDevices を呼び出します。次に、最初の EnumDisplayDevices 呼び出しで得られた DISPLAY_DEVICE.DeviceName を lpDevice に設定し、iDevNum を 0 に設定して EnumDisplayDevices を呼び出します。これにより、DISPLAY_DEVICE.DeviceString がモニター名となります。

アダプターに関連付けられたすべてのモニターデバイスを照会するには、lpDevice にアダプター名を設定し、iDevNum を 0 から開始して関数が失敗するまでインクリメントしながら、EnumDisplayDevices をループ内で呼び出します。モニター情報を取得するための呼び出しのたびに DISPLAY_DEVICE.DeviceName が変化するため、アダプター名を保存しておく必要があることに注意してください。アダプターに対するモニターがなくなると、関数は失敗します。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして EnumDisplayDevices を定義しています。エンコーディングに依存しないエイリアスの使用を、エンコーディングに依存しないコードではないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

BOOL EnumDisplayDevicesW(
    LPCWSTR lpDevice,   // optional
    DWORD iDevNum,
    DISPLAY_DEVICEW* lpDisplayDevice,
    DWORD dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool EnumDisplayDevicesW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpDevice,   // LPCWSTR optional
    uint iDevNum,   // DWORD
    IntPtr lpDisplayDevice,   // DISPLAY_DEVICEW* in/out
    uint dwFlags   // DWORD
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumDisplayDevicesW(
    <MarshalAs(UnmanagedType.LPWStr)> lpDevice As String,   ' LPCWSTR optional
    iDevNum As UInteger,   ' DWORD
    lpDisplayDevice As IntPtr,   ' DISPLAY_DEVICEW* in/out
    dwFlags As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpDevice : LPCWSTR optional
' iDevNum : DWORD
' lpDisplayDevice : DISPLAY_DEVICEW* in/out
' dwFlags : DWORD
Declare PtrSafe Function EnumDisplayDevicesW Lib "user32" ( _
    ByVal lpDevice As LongPtr, _
    ByVal iDevNum As Long, _
    ByVal lpDisplayDevice As LongPtr, _
    ByVal dwFlags As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumDisplayDevicesW = ctypes.windll.user32.EnumDisplayDevicesW
EnumDisplayDevicesW.restype = wintypes.BOOL
EnumDisplayDevicesW.argtypes = [
    wintypes.LPCWSTR,  # lpDevice : LPCWSTR optional
    wintypes.DWORD,  # iDevNum : DWORD
    ctypes.c_void_p,  # lpDisplayDevice : DISPLAY_DEVICEW* in/out
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumDisplayDevicesW = Fiddle::Function.new(
  lib['EnumDisplayDevicesW'],
  [
    Fiddle::TYPE_VOIDP,  # lpDevice : LPCWSTR optional
    -Fiddle::TYPE_INT,  # iDevNum : DWORD
    Fiddle::TYPE_VOIDP,  # lpDisplayDevice : DISPLAY_DEVICEW* in/out
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn EnumDisplayDevicesW(
        lpDevice: *const u16,  // LPCWSTR optional
        iDevNum: u32,  // DWORD
        lpDisplayDevice: *mut DISPLAY_DEVICEW,  // DISPLAY_DEVICEW* in/out
        dwFlags: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern bool EnumDisplayDevicesW([MarshalAs(UnmanagedType.LPWStr)] string lpDevice, uint iDevNum, IntPtr lpDisplayDevice, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumDisplayDevicesW' -Namespace Win32 -PassThru
# $api::EnumDisplayDevicesW(lpDevice, iDevNum, lpDisplayDevice, dwFlags)

#uselib "USER32.dll"
#func global EnumDisplayDevicesW "EnumDisplayDevicesW" wptr, wptr, wptr, wptr
; EnumDisplayDevicesW lpDevice, iDevNum, varptr(lpDisplayDevice), dwFlags   ; 戻り値は stat
; lpDevice : LPCWSTR optional -> "wptr"
; iDevNum : DWORD -> "wptr"
; lpDisplayDevice : DISPLAY_DEVICEW* in/out -> "wptr"
; dwFlags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global EnumDisplayDevicesW "EnumDisplayDevicesW" wstr, int, var, int
; res = EnumDisplayDevicesW(lpDevice, iDevNum, lpDisplayDevice, dwFlags)
; lpDevice : LPCWSTR optional -> "wstr"
; iDevNum : DWORD -> "int"
; lpDisplayDevice : DISPLAY_DEVICEW* in/out -> "var"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global EnumDisplayDevicesW "EnumDisplayDevicesW" wstr, int, sptr, int
; res = EnumDisplayDevicesW(lpDevice, iDevNum, varptr(lpDisplayDevice), dwFlags)
; lpDevice : LPCWSTR optional -> "wstr"
; iDevNum : DWORD -> "int"
; lpDisplayDevice : DISPLAY_DEVICEW* in/out -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。