EnumDisplaySettingsExA 関数 (winuser.h)

[アーティクル]
03/13/2024

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

この関数は、dwFlags パラメーターがあるという点で EnumDisplaySettings とは異なります。

メモWindows 8以降をターゲットにするように設計したアプリでは、1 ピクセルあたり 32 ビット (bpp) 未満の表示モードに対してクエリを実行したり設定したりできなくなりました。これらの操作は失敗します。これらのアプリには、Windows 8を対象とする互換性マニフェストがあります。 Windows 8では、Windows 8 マニフェストなしでビルドされたデスクトップアプリの 8 ビットと 16 ビットのカラーモードが引き続きサポートされます。Windows 8は、これらのモードをエミュレートしますが、32 ビットカラーモードで実行されます。

構文

BOOL EnumDisplaySettingsExA(
  [in]  LPCSTR   lpszDeviceName,
  [in]  DWORD    iModeNum,
  [out] DEVMODEA *lpDevMode,
  [in]  DWORD    dwFlags
);

パラメーター

[in] lpszDeviceName

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

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

[in] iModeNum

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

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

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

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

[out] lpDevMode

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

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

dmBitsPerPel
dmPelsWidth
dmPelsHeight
dmDisplayFlags
dmDisplayFrequency
dmPosition
dmDisplayOrientation

[in] dwFlags

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

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

戻り値

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

関数が失敗した場合は、0 を返します。

注釈

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

DPI 仮想化

この API は DPI 仮想化には参加しません。指定された出力は常に物理ピクセルの観点からであり、呼び出し元のコンテキストには関連しません。

注意

winuser.h ヘッダーは EnumDisplaySettingsEx をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイルエラーまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll
API セット	ext-ms-win-ntuser-sysparams-ext-l1-1-1 (Windows 10 バージョン 10.0.14393 で導入)