ホーム › Devices.DeviceAndDriverInstallation › SetupQuerySourceListA

SetupQuerySourceListA

関数

現在のソースリストの内容を照会して取得する(ANSI)。

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

シグネチャ

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

BOOL SetupQuerySourceListA(
    DWORD Flags,
    LPCSTR** List,
    DWORD* Count
);

パラメーター

名前	型	方向	説明
Flags	DWORD	in	照会するリストを指定します。このパラメーターには、次の値の任意の組み合わせを指定できます。 SRCLIST_SYSTEM システムのリストを照会します。 SRCLIST_USER ユーザーごとのリストを照会します。メモシステムのリストとユーザーのリストの両方を取得した場合、システムのリストの項目が先に来る形で両者はマージされます。メモ上記のいずれのフラグも指定されない場合は、現在の (マージされた) リスト全体が返されます。 SRCLIST_NOSTRIPPLATFORM 通常、すべてのパスは、末尾の要素がプラットフォーム固有の要素である場合にその要素が取り除かれます。たとえば、レジストリに f:\x86 として格納されているパスは f:\ として返されます。このフラグを指定すると、プラットフォーム固有の要素は取り除かれません。
List	LPCSTR**	out	この関数がソースの配列へのポインターを返す変数へのポインターです。null 終端文字列を使用します。呼び出し元は、 SetupFreeSourceList を呼び出してこの配列を解放する必要があります。
Count	DWORD*	out	この関数がリスト内のソースの数を返す変数へのポインターです。

名前

型

方向

説明

Flags

DWORD

照会するリストを指定します。このパラメーターには、次の値の任意の組み合わせを指定できます。

SRCLIST_USER

ユーザーごとのリストを照会します。

メモシステムのリストとユーザーのリストの両方を取得した場合、システムのリストの項目が先に来る形で両者はマージされます。

メモ上記のいずれのフラグも指定されない場合は、現在の (マージされた) リスト全体が返されます。

SRCLIST_NOSTRIPPLATFORM

通常、すべてのパスは、末尾の要素がプラットフォーム固有の要素である場合にその要素が取り除かれます。たとえば、レジストリに f:\x86 として格納されているパスは f:\ として返されます。このフラグを指定すると、プラットフォーム固有の要素は取り除かれません。

List

LPCSTR**

out

この関数がソースの配列へのポインターを返す変数へのポインターです。null 終端文字列を使用します。呼び出し元は、 SetupFreeSourceList を呼び出してこの配列を解放する必要があります。

Count

DWORD*

out

この関数がリスト内のソースの数を返す変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

SetupQuerySourceList 関数は、現在のインストールソースのリストを照会します。このリストはシステム単位のリストとユーザー単位のリストから構築され、一時的なリストによって上書きされる場合があります (SetupSetSourceList を参照)。(ANSI)

戻り値

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

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SetupQuerySourceListA(
    DWORD Flags,
    LPCSTR** List,
    DWORD* Count
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupQuerySourceListA(
    uint Flags,   // DWORD
    IntPtr List,   // LPCSTR** out
    out uint Count   // DWORD* out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupQuerySourceListA(
    Flags As UInteger,   ' DWORD
    List As IntPtr,   ' LPCSTR** out
    <Out> ByRef Count As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Flags : DWORD
' List : LPCSTR** out
' Count : DWORD* out
Declare PtrSafe Function SetupQuerySourceListA Lib "setupapi" ( _
    ByVal Flags As Long, _
    ByVal List As LongPtr, _
    ByRef Count As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupQuerySourceListA = ctypes.windll.setupapi.SetupQuerySourceListA
SetupQuerySourceListA.restype = wintypes.BOOL
SetupQuerySourceListA.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # List : LPCSTR** out
    ctypes.POINTER(wintypes.DWORD),  # Count : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupQuerySourceListA = Fiddle::Function.new(
  lib['SetupQuerySourceListA'],
  [
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # List : LPCSTR** out
    Fiddle::TYPE_VOIDP,  # Count : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupQuerySourceListA(
        Flags: u32,  // DWORD
        List: *const *const *const u8,  // LPCSTR** out
        Count: *mut u32  // DWORD* 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 SetupQuerySourceListA(uint Flags, IntPtr List, out uint Count);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupQuerySourceListA' -Namespace Win32 -PassThru
# $api::SetupQuerySourceListA(Flags, List, Count)

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

出力引数:

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