ホーム › Graphics.Gdi › EnumDisplaySettingsW

EnumDisplaySettingsW

関数

ディスプレイデバイスが対応する表示モードを列挙する(Unicode版)。

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

シグネチャ

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

BOOL EnumDisplaySettingsW(
    LPCWSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEW* lpDevMode
);

パラメーター

名前型方向説明

lpszDeviceName

LPCWSTR

inoptional

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

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

iModeNum

ENUM_DISPLAY_SETTINGS_MODE

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

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

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

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

lpDevMode

DEVMODEW*

inout

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

EnumDisplaySettings 関数は、次の 5 つの DEVMODE メンバーに値を設定します。

dmBitsPerPel
dmPelsWidth
dmPelsHeight
dmDisplayFlags
dmDisplayFrequency

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

DPI 仮想化

この API は DPI 仮想化に関与しません。出力される値は常に物理ピクセル単位であり、呼び出し元のコンテキストとは関連しません。

メモ

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

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

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

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

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

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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