ホーム › Graphics.Gdi › EnumDisplaySettingsExA

EnumDisplaySettingsExA

関数

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

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

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDisplaySettingsExA(
    LPCSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEA* lpDevMode,
    ENUM_DISPLAY_SETTINGS_FLAGS dwFlags
);

パラメーター

名前

型

方向

説明

lpszDeviceName

LPCSTR

inoptional

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

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

iModeNum

ENUM_DISPLAY_SETTINGS_MODE

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

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

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

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

lpDevMode

DEVMODEA*

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

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

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

DPI 仮想化

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

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDisplaySettingsExA(
    LPCSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEA* lpDevMode,
    ENUM_DISPLAY_SETTINGS_FLAGS dwFlags
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool EnumDisplaySettingsExA(
    [MarshalAs(UnmanagedType.LPStr)] string lpszDeviceName,   // LPCSTR optional
    uint iModeNum,   // ENUM_DISPLAY_SETTINGS_MODE
    IntPtr lpDevMode,   // DEVMODEA* in/out
    uint dwFlags   // ENUM_DISPLAY_SETTINGS_FLAGS
);

<DllImport("USER32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function EnumDisplaySettingsExA(
    <MarshalAs(UnmanagedType.LPStr)> lpszDeviceName As String,   ' LPCSTR optional
    iModeNum As UInteger,   ' ENUM_DISPLAY_SETTINGS_MODE
    lpDevMode As IntPtr,   ' DEVMODEA* in/out
    dwFlags As UInteger   ' ENUM_DISPLAY_SETTINGS_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpszDeviceName : LPCSTR optional
' iModeNum : ENUM_DISPLAY_SETTINGS_MODE
' lpDevMode : DEVMODEA* in/out
' dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS
Declare PtrSafe Function EnumDisplaySettingsExA Lib "user32" ( _
    ByVal lpszDeviceName As String, _
    ByVal iModeNum As Long, _
    ByVal lpDevMode As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
EnumDisplaySettingsExA = Fiddle::Function.new(
  lib['EnumDisplaySettingsExA'],
  [
    Fiddle::TYPE_VOIDP,  # lpszDeviceName : LPCSTR optional
    -Fiddle::TYPE_INT,  # iModeNum : ENUM_DISPLAY_SETTINGS_MODE
    Fiddle::TYPE_VOIDP,  # lpDevMode : DEVMODEA* in/out
    -Fiddle::TYPE_INT,  # dwFlags : ENUM_DISPLAY_SETTINGS_FLAGS
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn EnumDisplaySettingsExA(
        lpszDeviceName: *const u8,  // LPCSTR optional
        iModeNum: u32,  // ENUM_DISPLAY_SETTINGS_MODE
        lpDevMode: *mut DEVMODEA,  // DEVMODEA* 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.Ansi)]
public static extern bool EnumDisplaySettingsExA([MarshalAs(UnmanagedType.LPStr)] string lpszDeviceName, uint iModeNum, IntPtr lpDevMode, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_EnumDisplaySettingsExA' -Namespace Win32 -PassThru
# $api::EnumDisplaySettingsExA(lpszDeviceName, iModeNum, lpDevMode, dwFlags)

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

出力引数:

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