ホーム › Devices.DeviceAndDriverInstallation › SetupQueryInfVersionInformationA

SetupQueryInfVersionInformationA

関数

INFのバージョン情報セクションから指定キーの値を取得する(ANSI)。

DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupQueryInfVersionInformationA(
    SP_INF_INFORMATION* InfInformation,
    DWORD InfIndex,
    LPCSTR Key,   // optional
    LPSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
InfInformation	SP_INF_INFORMATION*	in	SP_INF_INFORMATION 構造体へのポインター。この構造体は、 SetupGetInfInformation 関数の呼び出しによって以前に返されたものです。
InfIndex	DWORD	in	バージョン情報を取得する構成 INF ファイルのインデックス。このインデックスは [0, InfInformation.InfCount) の範囲を指定できます。つまり、0 から InfInformation.InfCount の直前までの値が有効です。
Key	LPCSTR	inoptional	取得する文字列に対応付けられたキー名を含む null 終端文字列への、省略可能なポインター。このパラメーターが NULL の場合、すべてのリソースキーが指定されたバッファーにコピーされます。各文字列は null 終端であり、リストの末尾にはさらに null が 1 つ付加されます。
ReturnBuffer	LPSTR	outoptional	NULL でない場合、ReturnBuffer は、この関数が INF ファイルのスタイルを返す、呼び出し側が用意した文字バッファーを指します。null 終端文字列を使用してください。null 終端文字列は、コピー先バッファーのサイズを超えてはなりません。関数を一度呼び出して必要なバッファーサイズを取得し、必要なメモリを割り当ててから、2 回目の呼び出しでデータを取得できます。この手法により、バッファーサイズの不足によるエラーを回避できます。「解説」セクションを参照してください。このパラメーターは NULL にできます。
ReturnBufferSize	DWORD	in	ReturnBuffer パラメーターが指すバッファーのサイズ (文字数単位)。この数には null 終端文字が含まれます。
RequiredSize	DWORD*	outoptional	NULL でない場合、ReturnBuffer パラメーターが指すバッファーに必要なサイズ (文字数単位) を受け取る変数へのポインター。この数には null 終端文字が含まれます。ReturnBuffer が指定されており、実際のサイズが ReturnBufferSize で指定された値より大きい場合、関数は失敗し、 GetLastError を呼び出すと ERROR_INSUFFICIENT_BUFFER が返されます。

戻り値の型: BOOL

公式ドキュメント

SetupQueryInfVersionInformation 関数は、SP_INF_INFORMATION 構造体から INF ファイルのバージョン情報をバッファーに返します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

この関数を ReturnBuffer に NULL、ReturnBufferSize に 0 を指定して呼び出した場合、関数は、指定されたデータを格納するために必要なバッファーサイズを RequiredSize が指す変数に格納します。これに成功した場合、戻り値は 0 以外の値です。それ以外の場合、戻り値は 0 であり、GetLastError を呼び出すことで拡張エラー情報を取得できます。

SetupQueryInfVersionInformation をレガシー INF ファイルに対して呼び出した場合、バージョン情報は次のようにレガシー INF ファイルから生成されます。

レガシーファイルの Identification セクションにある OptionType キーが、Class キーの値として返されます。
レガシー INF ファイルの Signature セクションにある FileType キーが、Signature キーの値になります。
レガシー INF ファイルの FileType キーの値が MICROSOFT_FILE の場合、Provider キーの値は "Microsoft" に設定されます。

次の表は、情報が SP_INF_INFORMATION 構造体に渡される前に、どのように変換されるかをまとめたものです。

レガシーファイルの情報	Windows INF の情報
`[Identification] OptionType = Mouse`	`[Version] Class=Mouse`
`[Signature] FileType = MICROSOFT_FILE`	`Signature=MICROSOFT_FILE`
(FileType が MICROSOFT_FILE の場合)	`Provider="Microsoft"`

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして SetupQueryInfVersionInformation を定義します。エンコーディングに中立なこのエイリアスの使用を、エンコーディングに中立でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

BOOL SetupQueryInfVersionInformationA(
    SP_INF_INFORMATION* InfInformation,
    DWORD InfIndex,
    LPCSTR Key,   // optional
    LPSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupQueryInfVersionInformationA(
    IntPtr InfInformation,   // SP_INF_INFORMATION*
    uint InfIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string Key,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer,   // LPSTR optional, out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupQueryInfVersionInformationA(
    InfInformation As IntPtr,   ' SP_INF_INFORMATION*
    InfIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> Key As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> ReturnBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' InfInformation : SP_INF_INFORMATION*
' InfIndex : DWORD
' Key : LPCSTR optional
' ReturnBuffer : LPSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupQueryInfVersionInformationA Lib "setupapi" ( _
    ByVal InfInformation As LongPtr, _
    ByVal InfIndex As Long, _
    ByVal Key As String, _
    ByVal ReturnBuffer As String, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupQueryInfVersionInformationA = ctypes.windll.setupapi.SetupQueryInfVersionInformationA
SetupQueryInfVersionInformationA.restype = wintypes.BOOL
SetupQueryInfVersionInformationA.argtypes = [
    ctypes.c_void_p,  # InfInformation : SP_INF_INFORMATION*
    wintypes.DWORD,  # InfIndex : DWORD
    wintypes.LPCSTR,  # Key : LPCSTR optional
    wintypes.LPSTR,  # ReturnBuffer : LPSTR optional, out
    wintypes.DWORD,  # ReturnBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupQueryInfVersionInformationA = Fiddle::Function.new(
  lib['SetupQueryInfVersionInformationA'],
  [
    Fiddle::TYPE_VOIDP,  # InfInformation : SP_INF_INFORMATION*
    -Fiddle::TYPE_INT,  # InfIndex : DWORD
    Fiddle::TYPE_VOIDP,  # Key : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupQueryInfVersionInformationA(
        InfInformation: *mut SP_INF_INFORMATION,  // SP_INF_INFORMATION*
        InfIndex: u32,  // DWORD
        Key: *const u8,  // LPCSTR optional
        ReturnBuffer: *mut u8,  // LPSTR optional, out
        ReturnBufferSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool SetupQueryInfVersionInformationA(IntPtr InfInformation, uint InfIndex, [MarshalAs(UnmanagedType.LPStr)] string Key, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupQueryInfVersionInformationA' -Namespace Win32 -PassThru
# $api::SetupQueryInfVersionInformationA(InfInformation, InfIndex, Key, ReturnBuffer, ReturnBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupQueryInfVersionInformationA "SetupQueryInfVersionInformationA" sptr, sptr, sptr, sptr, sptr, sptr
; SetupQueryInfVersionInformationA varptr(InfInformation), InfIndex, Key, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; InfInformation : SP_INF_INFORMATION* -> "sptr"
; InfIndex : DWORD -> "sptr"
; Key : LPCSTR optional -> "sptr"
; ReturnBuffer : LPSTR optional, out -> "sptr"
; ReturnBufferSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupQueryInfVersionInformationA "SetupQueryInfVersionInformationA" var, int, str, var, int, var
; res = SetupQueryInfVersionInformationA(InfInformation, InfIndex, Key, ReturnBuffer, ReturnBufferSize, RequiredSize)
; InfInformation : SP_INF_INFORMATION* -> "var"
; InfIndex : DWORD -> "int"
; Key : LPCSTR optional -> "str"
; ReturnBuffer : LPSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupQueryInfVersionInformationA "SetupQueryInfVersionInformationA" sptr, int, str, sptr, int, sptr
; res = SetupQueryInfVersionInformationA(varptr(InfInformation), InfIndex, Key, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize))
; InfInformation : SP_INF_INFORMATION* -> "sptr"
; InfIndex : DWORD -> "int"
; Key : LPCSTR optional -> "str"
; ReturnBuffer : LPSTR optional, out -> "sptr"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。