ホーム › Devices.Display › GetCapabilitiesStringLength

GetCapabilitiesStringLength

関数

モニタの機能記述文字列の長さを取得する。

DLLdxva2.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

INT GetCapabilitiesStringLength(
    HANDLE hMonitor,
    DWORD* pdwCapabilitiesStringLengthInCharacters
);

パラメーター

名前	型	方向	説明
hMonitor	HANDLE	in	物理モニターへのハンドル。モニターハンドルを取得するには、GetPhysicalMonitorsFromHMONITOR または GetPhysicalMonitorsFromIDirect3DDevice9 を呼び出します。
pdwCapabilitiesStringLengthInCharacters	DWORD*	out	capabilities 文字列の長さを、終端の null 文字を含めた文字数で受け取ります。

戻り値の型: INT

公式ドキュメント

モニターの capabilities 文字列の長さを取得します。

戻り値

関数が成功した場合、戻り値は TRUE です。関数が失敗した場合、戻り値は FALSE です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数は通常はすぐに返りますが、完了までに数秒かかる場合があります。

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

各言語での呼び出し定義

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

INT GetCapabilitiesStringLength(
    HANDLE hMonitor,
    DWORD* pdwCapabilitiesStringLengthInCharacters
);

[DllImport("dxva2.dll", SetLastError = true, ExactSpelling = true)]
static extern int GetCapabilitiesStringLength(
    IntPtr hMonitor,   // HANDLE
    out uint pdwCapabilitiesStringLengthInCharacters   // DWORD* out
);

<DllImport("dxva2.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCapabilitiesStringLength(
    hMonitor As IntPtr,   ' HANDLE
    <Out> ByRef pdwCapabilitiesStringLengthInCharacters As UInteger   ' DWORD* out
) As Integer
End Function

' hMonitor : HANDLE
' pdwCapabilitiesStringLengthInCharacters : DWORD* out
Declare PtrSafe Function GetCapabilitiesStringLength Lib "dxva2" ( _
    ByVal hMonitor As LongPtr, _
    ByRef pdwCapabilitiesStringLengthInCharacters As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCapabilitiesStringLength = ctypes.windll.dxva2.GetCapabilitiesStringLength
GetCapabilitiesStringLength.restype = ctypes.c_int
GetCapabilitiesStringLength.argtypes = [
    wintypes.HANDLE,  # hMonitor : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # pdwCapabilitiesStringLengthInCharacters : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dxva2.dll')
GetCapabilitiesStringLength = Fiddle::Function.new(
  lib['GetCapabilitiesStringLength'],
  [
    Fiddle::TYPE_VOIDP,  # hMonitor : HANDLE
    Fiddle::TYPE_VOIDP,  # pdwCapabilitiesStringLengthInCharacters : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "dxva2")]
extern "system" {
    fn GetCapabilitiesStringLength(
        hMonitor: *mut core::ffi::c_void,  // HANDLE
        pdwCapabilitiesStringLengthInCharacters: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dxva2.dll", SetLastError = true)]
public static extern int GetCapabilitiesStringLength(IntPtr hMonitor, out uint pdwCapabilitiesStringLengthInCharacters);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dxva2_GetCapabilitiesStringLength' -Namespace Win32 -PassThru
# $api::GetCapabilitiesStringLength(hMonitor, pdwCapabilitiesStringLengthInCharacters)

#uselib "dxva2.dll"
#func global GetCapabilitiesStringLength "GetCapabilitiesStringLength" sptr, sptr
; GetCapabilitiesStringLength hMonitor, varptr(pdwCapabilitiesStringLengthInCharacters)   ; 戻り値は stat
; hMonitor : HANDLE -> "sptr"
; pdwCapabilitiesStringLengthInCharacters : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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