Win32 API 日本語リファレンス
ホーム › Devices.Display › GetDisplayConfigBufferSizes

GetDisplayConfigBufferSizes

関数
ディスプレイ構成取得に必要なバッファサイズを取得する。
DLLUSER32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetDisplayConfigBufferSizes(
    QUERY_DISPLAY_CONFIG_FLAGS flags,
    DWORD* numPathArrayElements,
    DWORD* numModeInfoArrayElements
);

パラメーター

名前型方向説明
flagsQUERY_DISPLAY_CONFIG_FLAGSin

取得する情報の種類です。Flags パラメーターの値は、次のいずれかの値である必要があります。

QDC_ALL_PATHS

呼び出し元は、可能なすべてのパスの組み合わせを保持するためのテーブルサイズを要求します。

QDC_ONLY_ACTIVE_PATHS

呼び出し元は、アクティブなパスのみを保持するためのテーブルサイズを要求します。

QDC_DATABASE_CURRENT

呼び出し元は、現在接続されているモニターについて永続化データベースに定義されたアクティブなパスを保持するためのテーブルサイズを要求します。

numPathArrayElementsDWORD*outパス情報テーブルの要素数を受け取る変数へのポインターです。pNumPathArrayElements パラメーターの値は、その後の QueryDisplayConfig 関数の呼び出しで使用されます。このパラメーターを NULL にすることはできません。
numModeInfoArrayElementsDWORD*outモード情報テーブルの要素数を受け取る変数へのポインターです。pNumModeInfoArrayElements パラメーターの値は、その後の QueryDisplayConfig 関数の呼び出しで使用されます。このパラメーターを NULL にすることはできません。

戻り値の型: WIN32_ERROR

公式ドキュメント

GetDisplayConfigBufferSizes 関数は、QueryDisplayConfig 関数を呼び出すために必要なバッファのサイズを取得します。

戻り値

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

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

解説(Remarks)

現在のディスプレイパス構成と要求されたフラグに基づき、GetDisplayConfigBufferSizes は情報を格納するために必要なパステーブルおよびモードテーブルのサイズを返します。GetDisplayConfigBufferSizes は、すべてのソースパスおよびターゲットパスが有効であると判断するため、実際に必要なサイズよりもわずかに大きい値を返すことがあります。一方で、ドライバーは可能な組み合わせに何らかの制限を課している場合があります。

GetDisplayConfigBufferSizes はその時点で必要な配列サイズしか判断できないため、GetDisplayConfigBufferSizes と QueryDisplayConfig の呼び出しの間にシステム構成が変化し、提供された配列サイズでは新しいパスデータを格納するのに十分でなくなる可能性があります。

追加のソースおよびターゲットを有効にする必要があることを呼び出し元が認識している場合、呼び出し元は GetDisplayConfigBufferSizes から返される値よりも大きなモード情報配列を割り当てることができます。これにより、QueryDisplayConfig を呼び出した後、SetDisplayConfig を呼び出す前に、追加のソースモードおよびターゲットモードを追加するための領域を確保できます。

例

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

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

各言語での呼び出し定義

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

WIN32_ERROR GetDisplayConfigBufferSizes(
    QUERY_DISPLAY_CONFIG_FLAGS flags,
    DWORD* numPathArrayElements,
    DWORD* numModeInfoArrayElements
);
[DllImport("USER32.dll", ExactSpelling = true)]
static extern uint GetDisplayConfigBufferSizes(
    uint flags,   // QUERY_DISPLAY_CONFIG_FLAGS
    out uint numPathArrayElements,   // DWORD* out
    out uint numModeInfoArrayElements   // DWORD* out
);
<DllImport("USER32.dll", ExactSpelling:=True)>
Public Shared Function GetDisplayConfigBufferSizes(
    flags As UInteger,   ' QUERY_DISPLAY_CONFIG_FLAGS
    <Out> ByRef numPathArrayElements As UInteger,   ' DWORD* out
    <Out> ByRef numModeInfoArrayElements As UInteger   ' DWORD* out
) As UInteger
End Function
' flags : QUERY_DISPLAY_CONFIG_FLAGS
' numPathArrayElements : DWORD* out
' numModeInfoArrayElements : DWORD* out
Declare PtrSafe Function GetDisplayConfigBufferSizes Lib "user32" ( _
    ByVal flags As Long, _
    ByRef numPathArrayElements As Long, _
    ByRef numModeInfoArrayElements As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetDisplayConfigBufferSizes = ctypes.windll.user32.GetDisplayConfigBufferSizes
GetDisplayConfigBufferSizes.restype = wintypes.DWORD
GetDisplayConfigBufferSizes.argtypes = [
    wintypes.DWORD,  # flags : QUERY_DISPLAY_CONFIG_FLAGS
    ctypes.POINTER(wintypes.DWORD),  # numPathArrayElements : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # numModeInfoArrayElements : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
GetDisplayConfigBufferSizes = Fiddle::Function.new(
  lib['GetDisplayConfigBufferSizes'],
  [
    -Fiddle::TYPE_INT,  # flags : QUERY_DISPLAY_CONFIG_FLAGS
    Fiddle::TYPE_VOIDP,  # numPathArrayElements : DWORD* out
    Fiddle::TYPE_VOIDP,  # numModeInfoArrayElements : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn GetDisplayConfigBufferSizes(
        flags: u32,  // QUERY_DISPLAY_CONFIG_FLAGS
        numPathArrayElements: *mut u32,  // DWORD* out
        numModeInfoArrayElements: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll")]
public static extern uint GetDisplayConfigBufferSizes(uint flags, out uint numPathArrayElements, out uint numModeInfoArrayElements);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_GetDisplayConfigBufferSizes' -Namespace Win32 -PassThru
# $api::GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
#uselib "USER32.dll"
#func global GetDisplayConfigBufferSizes "GetDisplayConfigBufferSizes" sptr, sptr, sptr
; GetDisplayConfigBufferSizes flags, varptr(numPathArrayElements), varptr(numModeInfoArrayElements)   ; 戻り値は stat
; flags : QUERY_DISPLAY_CONFIG_FLAGS -> "sptr"
; numPathArrayElements : DWORD* out -> "sptr"
; numModeInfoArrayElements : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "USER32.dll"
#cfunc global GetDisplayConfigBufferSizes "GetDisplayConfigBufferSizes" int, var, var
; res = GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
; flags : QUERY_DISPLAY_CONFIG_FLAGS -> "int"
; numPathArrayElements : DWORD* out -> "var"
; numModeInfoArrayElements : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; WIN32_ERROR GetDisplayConfigBufferSizes(QUERY_DISPLAY_CONFIG_FLAGS flags, DWORD* numPathArrayElements, DWORD* numModeInfoArrayElements)
#uselib "USER32.dll"
#cfunc global GetDisplayConfigBufferSizes "GetDisplayConfigBufferSizes" int, var, var
; res = GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
; flags : QUERY_DISPLAY_CONFIG_FLAGS -> "int"
; numPathArrayElements : DWORD* out -> "var"
; numModeInfoArrayElements : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procGetDisplayConfigBufferSizes = user32.NewProc("GetDisplayConfigBufferSizes")
)

// flags (QUERY_DISPLAY_CONFIG_FLAGS), numPathArrayElements (DWORD* out), numModeInfoArrayElements (DWORD* out)
r1, _, err := procGetDisplayConfigBufferSizes.Call(
	uintptr(flags),
	uintptr(numPathArrayElements),
	uintptr(numModeInfoArrayElements),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // WIN32_ERROR
function GetDisplayConfigBufferSizes(
  flags: DWORD;   // QUERY_DISPLAY_CONFIG_FLAGS
  numPathArrayElements: Pointer;   // DWORD* out
  numModeInfoArrayElements: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'USER32.dll' name 'GetDisplayConfigBufferSizes';
result := DllCall("USER32\GetDisplayConfigBufferSizes"
    , "UInt", flags   ; QUERY_DISPLAY_CONFIG_FLAGS
    , "Ptr", numPathArrayElements   ; DWORD* out
    , "Ptr", numModeInfoArrayElements   ; DWORD* out
    , "UInt")   ; return: WIN32_ERROR
●GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements) = DLL("USER32.dll", "dword GetDisplayConfigBufferSizes(dword, void*, void*)")
# 呼び出し: GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
# flags : QUERY_DISPLAY_CONFIG_FLAGS -> "dword"
# numPathArrayElements : DWORD* out -> "void*"
# numModeInfoArrayElements : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn GetDisplayConfigBufferSizes(
    flags: u32, // QUERY_DISPLAY_CONFIG_FLAGS
    numPathArrayElements: [*c]u32, // DWORD* out
    numModeInfoArrayElements: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc GetDisplayConfigBufferSizes(
    flags: uint32,  # QUERY_DISPLAY_CONFIG_FLAGS
    numPathArrayElements: ptr uint32,  # DWORD* out
    numModeInfoArrayElements: ptr uint32  # DWORD* out
): uint32 {.importc: "GetDisplayConfigBufferSizes", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
uint GetDisplayConfigBufferSizes(
    uint flags,   // QUERY_DISPLAY_CONFIG_FLAGS
    uint* numPathArrayElements,   // DWORD* out
    uint* numModeInfoArrayElements   // DWORD* out
);
ccall((:GetDisplayConfigBufferSizes, "USER32.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt32}, Ptr{UInt32}),
      flags, numPathArrayElements, numModeInfoArrayElements)
# flags : QUERY_DISPLAY_CONFIG_FLAGS -> UInt32
# numPathArrayElements : DWORD* out -> Ptr{UInt32}
# numModeInfoArrayElements : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetDisplayConfigBufferSizes(
    uint32_t flags,
    uint32_t* numPathArrayElements,
    uint32_t* numModeInfoArrayElements);
]]
local user32 = ffi.load("user32")
-- user32.GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
-- flags : QUERY_DISPLAY_CONFIG_FLAGS
-- numPathArrayElements : DWORD* out
-- numModeInfoArrayElements : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const GetDisplayConfigBufferSizes = lib.func('__stdcall', 'GetDisplayConfigBufferSizes', 'uint32_t', ['uint32_t', 'uint32_t *', 'uint32_t *']);
// GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
// flags : QUERY_DISPLAY_CONFIG_FLAGS -> 'uint32_t'
// numPathArrayElements : DWORD* out -> 'uint32_t *'
// numModeInfoArrayElements : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  GetDisplayConfigBufferSizes: { parameters: ["u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements)
// flags : QUERY_DISPLAY_CONFIG_FLAGS -> "u32"
// numPathArrayElements : DWORD* out -> "pointer"
// numModeInfoArrayElements : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetDisplayConfigBufferSizes(
    uint32_t flags,
    uint32_t* numPathArrayElements,
    uint32_t* numModeInfoArrayElements);
C, "USER32.dll");
// $ffi->GetDisplayConfigBufferSizes(flags, numPathArrayElements, numModeInfoArrayElements);
// flags : QUERY_DISPLAY_CONFIG_FLAGS
// numPathArrayElements : DWORD* out
// numModeInfoArrayElements : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    int GetDisplayConfigBufferSizes(
        int flags,   // QUERY_DISPLAY_CONFIG_FLAGS
        IntByReference numPathArrayElements,   // DWORD* out
        IntByReference numModeInfoArrayElements   // DWORD* out
    );
}
@[Link("user32")]
lib LibUSER32
  fun GetDisplayConfigBufferSizes = GetDisplayConfigBufferSizes(
    flags : UInt32,   # QUERY_DISPLAY_CONFIG_FLAGS
    numPathArrayElements : UInt32*,   # DWORD* out
    numModeInfoArrayElements : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetDisplayConfigBufferSizesNative = Uint32 Function(Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef GetDisplayConfigBufferSizesDart = int Function(int, Pointer<Uint32>, Pointer<Uint32>);
final GetDisplayConfigBufferSizes = DynamicLibrary.open('USER32.dll')
    .lookupFunction<GetDisplayConfigBufferSizesNative, GetDisplayConfigBufferSizesDart>('GetDisplayConfigBufferSizes');
// flags : QUERY_DISPLAY_CONFIG_FLAGS -> Uint32
// numPathArrayElements : DWORD* out -> Pointer<Uint32>
// numModeInfoArrayElements : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetDisplayConfigBufferSizes(
  flags: DWORD;   // QUERY_DISPLAY_CONFIG_FLAGS
  numPathArrayElements: Pointer;   // DWORD* out
  numModeInfoArrayElements: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'USER32.dll' name 'GetDisplayConfigBufferSizes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetDisplayConfigBufferSizes"
  c_GetDisplayConfigBufferSizes :: Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- flags : QUERY_DISPLAY_CONFIG_FLAGS -> Word32
-- numPathArrayElements : DWORD* out -> Ptr Word32
-- numModeInfoArrayElements : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getdisplayconfigbuffersizes =
  foreign "GetDisplayConfigBufferSizes"
    (uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* flags : QUERY_DISPLAY_CONFIG_FLAGS -> uint32_t *)
(* numPathArrayElements : DWORD* out -> (ptr uint32_t) *)
(* numModeInfoArrayElements : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("GetDisplayConfigBufferSizes" get-display-config-buffer-sizes :convention :stdcall) :uint32
  (flags :uint32)   ; QUERY_DISPLAY_CONFIG_FLAGS
  (num-path-array-elements :pointer)   ; DWORD* out
  (num-mode-info-array-elements :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetDisplayConfigBufferSizes = Win32::API::More->new('USER32',
    'DWORD GetDisplayConfigBufferSizes(DWORD flags, LPVOID numPathArrayElements, LPVOID numModeInfoArrayElements)');
# my $ret = $GetDisplayConfigBufferSizes->Call($flags, $numPathArrayElements, $numModeInfoArrayElements);
# flags : QUERY_DISPLAY_CONFIG_FLAGS -> DWORD
# numPathArrayElements : DWORD* out -> LPVOID
# numModeInfoArrayElements : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型