ホーム › Graphics.Gdi › EnumDisplaySettingsA

EnumDisplaySettingsA

関数

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

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

シグネチャ

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

BOOL EnumDisplaySettingsA(
    LPCSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEA* lpDevMode
);

パラメーター

名前型方向説明

lpszDeviceName

LPCSTR

inoptional

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

このパラメーターは NULL であるか、EnumDisplayDevices から返された DISPLAY_DEVICE.DeviceName です。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

DEVMODEA*

inout

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

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

dmBitsPerPel
dmPelsWidth
dmPelsHeight
dmDisplayFlags
dmDisplayFrequency

戻り値の型: BOOL

公式ドキュメント

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

戻り値

関数が成功した場合、戻り値は 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  (ANSI / -A)
#include <windows.h>

BOOL EnumDisplaySettingsA(
    LPCSTR lpszDeviceName,   // optional
    ENUM_DISPLAY_SETTINGS_MODE iModeNum,
    DEVMODEA* lpDevMode
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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