ホーム › Devices.DeviceAndDriverInstallation › SetupDiCreateDeviceInfoListExA

SetupDiCreateDeviceInfoListExA

関数

リモートマシン対応で空のデバイス情報セットを作成する。

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

シグネチャ

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

HDEVINFO SetupDiCreateDeviceInfoListExA(
    const GUID* ClassGuid,   // optional
    HWND hwndParent,   // optional
    LPCSTR MachineName,   // optional
    void* Reserved   // optional
);

パラメーター

名前	型	方向	説明
ClassGuid	GUID*	inoptional	新しく作成されるデバイス情報セットに関連付けるデバイスセットアップクラスの GUID へのポインター。このパラメーターを指定した場合、このデバイス情報セットにはこのクラスのデバイスのみを含めることができます。このパラメーターを NULL に設定した場合、デバイス情報セットは特定のデバイスセットアップクラスに関連付けられません。
hwndParent	HWND	inoptional	デバイス固有ではない操作 (グローバルクラスドライバーリストを使用するデバイス選択ダイアログボックスなど) に関連するユーザーインターフェイスに使用する、最上位ウィンドウへのハンドル。このハンドルは省略可能で、NULL を指定できます。特定の最上位ウィンドウが不要な場合は、hwndParent に NULL を設定します。
MachineName	LPCSTR	inoptional	ネットワーク上のコンピューター名を格納した NULL 終端文字列へのポインター。名前を指定した場合、このデバイス情報セットではそのコンピューター上のデバイスのみを作成および開くことができます。このパラメーターを NULL に設定した場合、デバイス情報セットはローカルコンピューター上のデバイスを対象とします。注意この関数を使用してリモートコンピューターにアクセスすることは、Windows 8 および Windows Server 2012 以降ではサポートされていません。この機能は削除されました。
Reserved	void*	optional	NULL でなければなりません。

戻り値の型: HDEVINFO

公式ドキュメント

SetupDiCreateDeviceInfoList 関数は、リモートコンピューターまたはローカルコンピューター上に空のデバイス情報セットを作成し、必要に応じてそのセットをデバイスセットアップクラスに関連付けます。(ANSI)

戻り値

関数が成功した場合、空のデバイス情報セットへのハンドルを返します。それ以外の場合は INVALID_HANDLE_VALUE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

この関数の呼び出し元は、返されたデバイス情報セットが不要になった時点で、SetupDiDestroyDeviceInfoList を呼び出して削除する必要があります。

デバイス情報セットがリモートコンピューター上のデバイスを対象とする場合 (MachineName が NULL でない場合)、このセットまたはその要素に対する以降のすべての操作では、リモート要素を含むデバイス情報セットをサポートするルーチンを使用する必要があります。このサポートを提供しない SetupDiXxx ルーチン (SetupDiCallClassInstaller など) には、そのリファレンスページにその旨の記述があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

HDEVINFO SetupDiCreateDeviceInfoListExA(
    const GUID* ClassGuid,   // optional
    HWND hwndParent,   // optional
    LPCSTR MachineName,   // optional
    void* Reserved   // optional
);

[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr SetupDiCreateDeviceInfoListExA(
    IntPtr ClassGuid,   // GUID* optional
    IntPtr hwndParent,   // HWND optional
    [MarshalAs(UnmanagedType.LPStr)] string MachineName,   // LPCSTR optional
    IntPtr Reserved   // void* optional
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiCreateDeviceInfoListExA(
    ClassGuid As IntPtr,   ' GUID* optional
    hwndParent As IntPtr,   ' HWND optional
    <MarshalAs(UnmanagedType.LPStr)> MachineName As String,   ' LPCSTR optional
    Reserved As IntPtr   ' void* optional
) As IntPtr
End Function

' ClassGuid : GUID* optional
' hwndParent : HWND optional
' MachineName : LPCSTR optional
' Reserved : void* optional
Declare PtrSafe Function SetupDiCreateDeviceInfoListExA Lib "setupapi" ( _
    ByVal ClassGuid As LongPtr, _
    ByVal hwndParent As LongPtr, _
    ByVal MachineName As String, _
    ByVal Reserved As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetupDiCreateDeviceInfoListExA = ctypes.windll.setupapi.SetupDiCreateDeviceInfoListExA
SetupDiCreateDeviceInfoListExA.restype = ctypes.c_ssize_t
SetupDiCreateDeviceInfoListExA.argtypes = [
    ctypes.c_void_p,  # ClassGuid : GUID* optional
    wintypes.HANDLE,  # hwndParent : HWND optional
    wintypes.LPCSTR,  # MachineName : LPCSTR optional
    ctypes.POINTER(None),  # Reserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiCreateDeviceInfoListExA = Fiddle::Function.new(
  lib['SetupDiCreateDeviceInfoListExA'],
  [
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # hwndParent : HWND optional
    Fiddle::TYPE_VOIDP,  # MachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INTPTR_T)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiCreateDeviceInfoListExA(
        ClassGuid: *const GUID,  // GUID* optional
        hwndParent: *mut core::ffi::c_void,  // HWND optional
        MachineName: *const u8,  // LPCSTR optional
        Reserved: *mut ()  // void* optional
    ) -> isize;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr SetupDiCreateDeviceInfoListExA(IntPtr ClassGuid, IntPtr hwndParent, [MarshalAs(UnmanagedType.LPStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiCreateDeviceInfoListExA' -Namespace Win32 -PassThru
# $api::SetupDiCreateDeviceInfoListExA(ClassGuid, hwndParent, MachineName, Reserved)

#uselib "SETUPAPI.dll"
#func global SetupDiCreateDeviceInfoListExA "SetupDiCreateDeviceInfoListExA" sptr, sptr, sptr, sptr
; SetupDiCreateDeviceInfoListExA varptr(ClassGuid), hwndParent, MachineName, Reserved   ; 戻り値は stat
; ClassGuid : GUID* optional -> "sptr"
; hwndParent : HWND optional -> "sptr"
; MachineName : LPCSTR optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiCreateDeviceInfoListExA "SetupDiCreateDeviceInfoListExA" var, sptr, str, sptr
; res = SetupDiCreateDeviceInfoListExA(ClassGuid, hwndParent, MachineName, Reserved)
; ClassGuid : GUID* optional -> "var"
; hwndParent : HWND optional -> "sptr"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiCreateDeviceInfoListExA "SetupDiCreateDeviceInfoListExA" sptr, sptr, str, sptr
; res = SetupDiCreateDeviceInfoListExA(varptr(ClassGuid), hwndParent, MachineName, Reserved)
; ClassGuid : GUID* optional -> "sptr"
; hwndParent : HWND optional -> "sptr"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。