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

SetupDiGetHwProfileList

関数
システムのハードウェアプロファイル一覧を取得する。
DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetupDiGetHwProfileList(
    DWORD* HwProfileList,
    DWORD HwProfileListSize,
    DWORD* RequiredSize,
    DWORD* CurrentlyActiveIndex   // optional
);

パラメーター

名前方向説明
HwProfileListDWORD*outシステムのハードウェアプロファイルID配列を受け取るバッファ。
HwProfileListSizeDWORDinHwProfileList配列が保持できる要素数。
RequiredSizeDWORD*out実際に必要な要素数を受け取るポインタ。サイズ照会に使う。
CurrentlyActiveIndexDWORD*outoptional現在アクティブなプロファイルの配列内インデックスを受け取るポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupDiGetHwProfileList(
    DWORD* HwProfileList,
    DWORD HwProfileListSize,
    DWORD* RequiredSize,
    DWORD* CurrentlyActiveIndex   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetHwProfileList(
    out uint HwProfileList,   // DWORD* out
    uint HwProfileListSize,   // DWORD
    out uint RequiredSize,   // DWORD* out
    IntPtr CurrentlyActiveIndex   // DWORD* optional, out
);
<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetHwProfileList(
    <Out> ByRef HwProfileList As UInteger,   ' DWORD* out
    HwProfileListSize As UInteger,   ' DWORD
    <Out> ByRef RequiredSize As UInteger,   ' DWORD* out
    CurrentlyActiveIndex As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' HwProfileList : DWORD* out
' HwProfileListSize : DWORD
' RequiredSize : DWORD* out
' CurrentlyActiveIndex : DWORD* optional, out
Declare PtrSafe Function SetupDiGetHwProfileList Lib "setupapi" ( _
    ByRef HwProfileList As Long, _
    ByVal HwProfileListSize As Long, _
    ByRef RequiredSize As Long, _
    ByVal CurrentlyActiveIndex As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDiGetHwProfileList = ctypes.windll.setupapi.SetupDiGetHwProfileList
SetupDiGetHwProfileList.restype = wintypes.BOOL
SetupDiGetHwProfileList.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # HwProfileList : DWORD* out
    wintypes.DWORD,  # HwProfileListSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # CurrentlyActiveIndex : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetHwProfileList = setupapi.NewProc("SetupDiGetHwProfileList")
)

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

extern "setupapi" fn SetupDiGetHwProfileList(
    HwProfileList: [*c]u32, // DWORD* out
    HwProfileListSize: u32, // DWORD
    RequiredSize: [*c]u32, // DWORD* out
    CurrentlyActiveIndex: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SetupDiGetHwProfileList(
    HwProfileList: ptr uint32,  # DWORD* out
    HwProfileListSize: uint32,  # DWORD
    RequiredSize: ptr uint32,  # DWORD* out
    CurrentlyActiveIndex: ptr uint32  # DWORD* optional, out
): int32 {.importc: "SetupDiGetHwProfileList", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetHwProfileList(
    uint* HwProfileList,   // DWORD* out
    uint HwProfileListSize,   // DWORD
    uint* RequiredSize,   // DWORD* out
    uint* CurrentlyActiveIndex   // DWORD* optional, out
);
ccall((:SetupDiGetHwProfileList, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{UInt32}, UInt32, Ptr{UInt32}, Ptr{UInt32}),
      HwProfileList, HwProfileListSize, RequiredSize, CurrentlyActiveIndex)
# HwProfileList : DWORD* out -> Ptr{UInt32}
# HwProfileListSize : DWORD -> UInt32
# RequiredSize : DWORD* out -> Ptr{UInt32}
# CurrentlyActiveIndex : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetHwProfileList(
    uint32_t* HwProfileList,
    uint32_t HwProfileListSize,
    uint32_t* RequiredSize,
    uint32_t* CurrentlyActiveIndex);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetHwProfileList(HwProfileList, HwProfileListSize, RequiredSize, CurrentlyActiveIndex)
-- HwProfileList : DWORD* out
-- HwProfileListSize : DWORD
-- RequiredSize : DWORD* out
-- CurrentlyActiveIndex : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetHwProfileList = lib.func('__stdcall', 'SetupDiGetHwProfileList', 'int32_t', ['uint32_t *', 'uint32_t', 'uint32_t *', 'uint32_t *']);
// SetupDiGetHwProfileList(HwProfileList, HwProfileListSize, RequiredSize, CurrentlyActiveIndex)
// HwProfileList : DWORD* out -> 'uint32_t *'
// HwProfileListSize : DWORD -> 'uint32_t'
// RequiredSize : DWORD* out -> 'uint32_t *'
// CurrentlyActiveIndex : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiGetHwProfileList: { parameters: ["pointer", "u32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetHwProfileList(HwProfileList, HwProfileListSize, RequiredSize, CurrentlyActiveIndex)
// HwProfileList : DWORD* out -> "pointer"
// HwProfileListSize : DWORD -> "u32"
// RequiredSize : DWORD* out -> "pointer"
// CurrentlyActiveIndex : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetHwProfileList(
    uint32_t* HwProfileList,
    uint32_t HwProfileListSize,
    uint32_t* RequiredSize,
    uint32_t* CurrentlyActiveIndex);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetHwProfileList(HwProfileList, HwProfileListSize, RequiredSize, CurrentlyActiveIndex);
// HwProfileList : DWORD* out
// HwProfileListSize : DWORD
// RequiredSize : DWORD* out
// CurrentlyActiveIndex : DWORD* optional, 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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class);
    boolean SetupDiGetHwProfileList(
        IntByReference HwProfileList,   // DWORD* out
        int HwProfileListSize,   // DWORD
        IntByReference RequiredSize,   // DWORD* out
        IntByReference CurrentlyActiveIndex   // DWORD* optional, out
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiGetHwProfileList = SetupDiGetHwProfileList(
    HwProfileList : UInt32*,   # DWORD* out
    HwProfileListSize : UInt32,   # DWORD
    RequiredSize : UInt32*,   # DWORD* out
    CurrentlyActiveIndex : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupDiGetHwProfileListNative = Int32 Function(Pointer<Uint32>, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef SetupDiGetHwProfileListDart = int Function(Pointer<Uint32>, int, Pointer<Uint32>, Pointer<Uint32>);
final SetupDiGetHwProfileList = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetHwProfileListNative, SetupDiGetHwProfileListDart>('SetupDiGetHwProfileList');
// HwProfileList : DWORD* out -> Pointer<Uint32>
// HwProfileListSize : DWORD -> Uint32
// RequiredSize : DWORD* out -> Pointer<Uint32>
// CurrentlyActiveIndex : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetHwProfileList(
  HwProfileList: Pointer;   // DWORD* out
  HwProfileListSize: DWORD;   // DWORD
  RequiredSize: Pointer;   // DWORD* out
  CurrentlyActiveIndex: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetHwProfileList';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiGetHwProfileList"
  c_SetupDiGetHwProfileList :: Ptr Word32 -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- HwProfileList : DWORD* out -> Ptr Word32
-- HwProfileListSize : DWORD -> Word32
-- RequiredSize : DWORD* out -> Ptr Word32
-- CurrentlyActiveIndex : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdigethwprofilelist =
  foreign "SetupDiGetHwProfileList"
    ((ptr uint32_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* HwProfileList : DWORD* out -> (ptr uint32_t) *)
(* HwProfileListSize : DWORD -> uint32_t *)
(* RequiredSize : DWORD* out -> (ptr uint32_t) *)
(* CurrentlyActiveIndex : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiGetHwProfileList" setup-di-get-hw-profile-list :convention :stdcall) :int32
  (hw-profile-list :pointer)   ; DWORD* out
  (hw-profile-list-size :uint32)   ; DWORD
  (required-size :pointer)   ; DWORD* out
  (currently-active-index :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiGetHwProfileList = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetHwProfileList(LPVOID HwProfileList, DWORD HwProfileListSize, LPVOID RequiredSize, LPVOID CurrentlyActiveIndex)');
# my $ret = $SetupDiGetHwProfileList->Call($HwProfileList, $HwProfileListSize, $RequiredSize, $CurrentlyActiveIndex);
# HwProfileList : DWORD* out -> LPVOID
# HwProfileListSize : DWORD -> DWORD
# RequiredSize : DWORD* out -> LPVOID
# CurrentlyActiveIndex : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API