ホーム › Devices.Display › DisplayConfigGetDeviceInfo

DisplayConfigGetDeviceInfo

関数

ディスプレイ構成のデバイス情報を取得する。

DLLUSER32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// USER32.dll
#include <windows.h>

INT DisplayConfigGetDeviceInfo(
    DISPLAYCONFIG_DEVICE_INFO_HEADER* requestPacket
);

パラメーター

名前	型	方向	説明
requestPacket	DISPLAYCONFIG_DEVICE_INFO_HEADER*	inout	DISPLAYCONFIG_DEVICE_INFO_HEADER 構造体へのポインター。この構造体には要求に関する情報が含まれ、type メンバーにはパケットの種類が格納されます。DisplayConfigGetDeviceInfo がヘッダー構造体に続いて返す追加データの種類とサイズは、パケットの種類によって異なります。

戻り値の型: INT

公式ドキュメント

DisplayConfigGetDeviceInfo 関数は、デバイスに関するディスプレイ構成情報を取得します。

戻り値

この関数は、次のいずれかの戻り値を返します。

戻り値	説明
ERROR_SUCCESS	関数は成功しました。
ERROR_INVALID_PARAMETER	指定されたパラメーターとフラグの組み合わせが無効です。
ERROR_NOT_SUPPORTED	システムが Windows Display Driver Model (WDDM) に準拠して作成されたグラフィックスドライバーで動作していません。この関数は、WDDM ドライバーが動作しているシステムでのみサポートされます。
ERROR_ACCESS_DENIED	呼び出し元にコンソールセッションへのアクセス権がありません。このエラーは、呼び出し元プロセスが現在のデスクトップにアクセスできない場合、またはリモートセッション上で実行されている場合に発生します。
ERROR_INSUFFICIENT_BUFFER	呼び出し元が渡したパケットのサイズが、呼び出し元が要求した情報に対して十分ではありません。
ERROR_GEN_FAILURE	不特定のエラーが発生しました。

解説(Remarks)

DisplayConfigGetDeviceInfo 関数を使用すると、アダプターのソースまたはターゲットに関する追加情報(ディスプレイ名、推奨ディスプレイモード、ソースデバイス名など)を取得できます。

呼び出し元は DisplayConfigGetDeviceInfo を呼び出して、ユーザーインターフェイスに表示する、よりわかりやすい名前を取得できます。アダプター、ソース、ターゲットの名前を取得できます。また、DisplayConfigGetDeviceInfo を呼び出して、接続されているディスプレイデバイスの最適な解像度を取得することもできます。

例

DisplayConfigGetDeviceInfo の使用例については、QueryDisplayConfig を参照してください。

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

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

INT DisplayConfigGetDeviceInfo(
    DISPLAYCONFIG_DEVICE_INFO_HEADER* requestPacket
);

[DllImport("USER32.dll", ExactSpelling = true)]
static extern int DisplayConfigGetDeviceInfo(
    IntPtr requestPacket   // DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
);

<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function DisplayConfigGetDeviceInfo(
    requestPacket As IntPtr   ' DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
) As Integer
End Function

' requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
Declare PtrSafe Function DisplayConfigGetDeviceInfo Lib "user32" ( _
    ByVal requestPacket As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DisplayConfigGetDeviceInfo = ctypes.windll.user32.DisplayConfigGetDeviceInfo
DisplayConfigGetDeviceInfo.restype = ctypes.c_int
DisplayConfigGetDeviceInfo.argtypes = [
    ctypes.c_void_p,  # requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
DisplayConfigGetDeviceInfo = Fiddle::Function.new(
  lib['DisplayConfigGetDeviceInfo'],
  [
    Fiddle::TYPE_VOIDP,  # requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "user32")]
extern "system" {
    fn DisplayConfigGetDeviceInfo(
        requestPacket: *mut DISPLAYCONFIG_DEVICE_INFO_HEADER  // DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll")]
public static extern int DisplayConfigGetDeviceInfo(IntPtr requestPacket);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_DisplayConfigGetDeviceInfo' -Namespace Win32 -PassThru
# $api::DisplayConfigGetDeviceInfo(requestPacket)

#uselib "USER32.dll"
#func global DisplayConfigGetDeviceInfo "DisplayConfigGetDeviceInfo" sptr
; DisplayConfigGetDeviceInfo varptr(requestPacket)   ; 戻り値は stat
; requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global DisplayConfigGetDeviceInfo "DisplayConfigGetDeviceInfo" var
; res = DisplayConfigGetDeviceInfo(requestPacket)
; requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global DisplayConfigGetDeviceInfo "DisplayConfigGetDeviceInfo" sptr
; res = DisplayConfigGetDeviceInfo(varptr(requestPacket))
; requestPacket : DISPLAYCONFIG_DEVICE_INFO_HEADER* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。