ホーム › Graphics.Gdi › EnumDisplaySettingsExW

EnumDisplaySettingsExW

関数

フラグを指定してディスプレイの表示モードを列挙する(Unicode版)。

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

シグネチャ

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

BOOL EnumDisplaySettingsExW(
    LPCWSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEW* lpDevMode,
    ENUM_DISPLAY_SETTINGS_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

lpszDeviceName

LPCWSTR

inoptional

関数が情報を取得するグラフィックモードの対象となるディスプレイデバイスを指定する、null 終端文字列へのポインターです。

このパラメーターは NULL であるか、DISPLAY_DEVICE です。DeviceName は EnumDisplayDevices から返されます。NULL 値は、呼び出し元スレッドが実行されているコンピューター上の現在のディスプレイデバイスを指定します。

iModeNum

ENUM_DISPLAY_SETTINGS_MODE

取得する情報の種類を指定します。この値はグラフィックモードのインデックス、または次のいずれかの値を指定できます。

Value	Meaning
ENUM_CURRENT_SETTINGS	ディスプレイデバイスの現在の設定を取得します。
ENUM_REGISTRY_SETTINGS	レジストリに現在格納されているディスプレイデバイスの設定を取得します。

グラフィックモードのインデックスはゼロから始まります。ディスプレイデバイスのすべてのグラフィックモードの情報を取得するには、次のように EnumDisplaySettingsEx を連続して呼び出します。最初の呼び出しでは iModeNum をゼロに設定し、後続の呼び出しごとに iModeNum を 1 ずつ増やします。戻り値がゼロになるまで関数の呼び出しを続けます。

iModeNum をゼロに設定して EnumDisplaySettingsEx を呼び出すと、オペレーティングシステムはディスプレイデバイスに関する情報を初期化してキャッシュします。iModeNum をゼロ以外の値に設定して EnumDisplaySettingsEx を呼び出すと、関数は iModeNum をゼロに設定して最後に関数を呼び出したときにキャッシュされた情報を返します。

lpDevMode

DEVMODEW*

inout

指定したグラフィックモードに関する情報を関数が格納する DEVMODE 構造体へのポインターです。EnumDisplaySettingsEx を呼び出す前に、dmSize メンバーを sizeof (DEVMODE) に設定し、dmDriverExtra メンバーには、プライベートなドライバーデータを受け取るために利用可能な追加領域のサイズ(バイト単位)を設定します。

EnumDisplaySettingsEx 関数は、lpDevMode の dmFields メンバーと、DEVMODE 構造体の 1 つ以上の他のメンバーを設定します。EnumDisplaySettingsEx の呼び出しによってどのメンバーが設定されたかを判別するには、dmFields ビットマスクを調べます。この関数によって通常設定されるフィールドには、次のようなものがあります。

dmBitsPerPel
dmPelsWidth
dmPelsHeight
dmDisplayFlags
dmDisplayFrequency
dmPosition
dmDisplayOrientation

dwFlags

ENUM_DISPLAY_SETTINGS_FLAGS

このパラメーターには次の値を指定できます。

Value	Meaning
EDS_RAWMODE	設定されている場合、関数はモニターの機能に関係なく、アダプタードライバーが報告するすべてのグラフィックモードを返します。設定されていない場合は、現在のモニターと互換性のあるモードのみを返します。
EDS_ROTATEDMODE	設定されている場合、関数はすべての向きのグラフィックモードを返します。設定されていない場合は、要求されたディスプレイに現在設定されている向きと同じ向きを持つモードのみを返します。

戻り値の型: BOOL

公式ドキュメント

EnumDisplaySettingsEx 関数は、ディスプレイデバイスのグラフィックモードの 1 つに関する情報を取得します。ディスプレイデバイスのすべてのグラフィックモードの情報を取得するには、この関数を連続して呼び出します。(Unicode)

戻り値

関数が成功すると、戻り値はゼロ以外になります。

関数が失敗すると、戻り値はゼロになります。

解説(Remarks)

iModeNum がディスプレイデバイスの最後のグラフィックモードのインデックスより大きい場合、関数は失敗します。iModeNum パラメーターの説明で述べたとおり、この動作を利用してディスプレイデバイスのすべてのグラフィックモードを列挙できます。

DPI 仮想化

この API は DPI 仮想化に対応していません。出力は常に物理ピクセル単位で与えられ、呼び出し元のコンテキストには関係しません。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 EnumDisplaySettingsExW(
    LPCWSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEW* lpDevMode,
    ENUM_DISPLAY_SETTINGS_FLAGS dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern bool EnumDisplaySettingsExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszDeviceName,   // LPCWSTR optional
    uint iModeNum,   // ENUM_DISPLAY_SETTINGS_MODE
    IntPtr lpDevMode,   // DEVMODEW* in/out
    uint dwFlags   // ENUM_DISPLAY_SETTINGS_FLAGS
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function EnumDisplaySettingsExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszDeviceName As String,   ' LPCWSTR optional
    iModeNum As UInteger,   ' ENUM_DISPLAY_SETTINGS_MODE
    lpDevMode As IntPtr,   ' DEVMODEW* in/out
    dwFlags As UInteger   ' ENUM_DISPLAY_SETTINGS_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszDeviceName : LPCWSTR optional
' iModeNum : ENUM_DISPLAY_SETTINGS_MODE
' lpDevMode : DEVMODEW* in/out
' dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS
Declare PtrSafe Function EnumDisplaySettingsExW Lib "user32" ( _
    ByVal lpszDeviceName As LongPtr, _
    ByVal iModeNum As Long, _
    ByVal lpDevMode 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

EnumDisplaySettingsExW = ctypes.windll.user32.EnumDisplaySettingsExW
EnumDisplaySettingsExW.restype = wintypes.BOOL
EnumDisplaySettingsExW.argtypes = [
    wintypes.LPCWSTR,  # lpszDeviceName : LPCWSTR optional
    wintypes.DWORD,  # iModeNum : ENUM_DISPLAY_SETTINGS_MODE
    ctypes.c_void_p,  # lpDevMode : DEVMODEW* in/out
    wintypes.DWORD,  # dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumDisplaySettingsExW = Fiddle::Function.new(
  lib['EnumDisplaySettingsExW'],
  [
    Fiddle::TYPE_VOIDP,  # lpszDeviceName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # iModeNum : ENUM_DISPLAY_SETTINGS_MODE
    Fiddle::TYPE_VOIDP,  # lpDevMode : DEVMODEW* in/out
    -Fiddle::TYPE_INT,  # dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn EnumDisplaySettingsExW(
        lpszDeviceName: *const u16,  // LPCWSTR optional
        iModeNum: u32,  // ENUM_DISPLAY_SETTINGS_MODE
        lpDevMode: *mut DEVMODEW,  // DEVMODEW* in/out
        dwFlags: u32  // ENUM_DISPLAY_SETTINGS_FLAGS
    ) -> 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 EnumDisplaySettingsExW([MarshalAs(UnmanagedType.LPWStr)] string lpszDeviceName, uint iModeNum, IntPtr lpDevMode, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumDisplaySettingsExW' -Namespace Win32 -PassThru
# $api::EnumDisplaySettingsExW(lpszDeviceName, iModeNum, lpDevMode, dwFlags)

#uselib "USER32.dll"
#func global EnumDisplaySettingsExW "EnumDisplaySettingsExW" wptr, wptr, wptr, wptr
; EnumDisplaySettingsExW lpszDeviceName, iModeNum, varptr(lpDevMode), dwFlags   ; 戻り値は stat
; lpszDeviceName : LPCWSTR optional -> "wptr"
; iModeNum : ENUM_DISPLAY_SETTINGS_MODE -> "wptr"
; lpDevMode : DEVMODEW* in/out -> "wptr"
; dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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