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

SetupDiGetDeviceInstallParamsW

関数
デバイスのインストールパラメータを取得する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetDeviceInstallParamsW(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SP_DEVINSTALL_PARAMS_W* DeviceInstallParams
);

パラメーター

名前方向説明
DeviceInfoSetHDEVINFOin対象のデバイス情報セットを指すハンドル。
DeviceInfoDataSP_DEVINFO_DATA*inoptionalインストールパラメータを取得する対象デバイスの構造体。NULL指定でセット全体のパラメータを得る。
DeviceInstallParamsSP_DEVINSTALL_PARAMS_W*inout現在のデバイスインストールパラメータを受け取る構造体(Unicode)。cbSizeを設定する。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll  (Unicode / -W)
#include <windows.h>

BOOL SetupDiGetDeviceInstallParamsW(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,   // optional
    SP_DEVINSTALL_PARAMS_W* DeviceInstallParams
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetDeviceInstallParamsW(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA* optional
    IntPtr DeviceInstallParams   // SP_DEVINSTALL_PARAMS_W* in/out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetDeviceInstallParamsW(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA* optional
    DeviceInstallParams As IntPtr   ' SP_DEVINSTALL_PARAMS_W* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA* optional
' DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out
Declare PtrSafe Function SetupDiGetDeviceInstallParamsW Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DeviceInfoData As LongPtr, _
    ByVal DeviceInstallParams As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDiGetDeviceInstallParamsW = ctypes.windll.setupapi.SetupDiGetDeviceInstallParamsW
SetupDiGetDeviceInstallParamsW.restype = wintypes.BOOL
SetupDiGetDeviceInstallParamsW.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA* optional
    ctypes.c_void_p,  # DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetDeviceInstallParamsW = Fiddle::Function.new(
  lib['SetupDiGetDeviceInstallParamsW'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA* optional
    Fiddle::TYPE_VOIDP,  # DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetDeviceInstallParamsW(
        DeviceInfoSet: isize,  // HDEVINFO
        DeviceInfoData: *mut SP_DEVINFO_DATA,  // SP_DEVINFO_DATA* optional
        DeviceInstallParams: *mut SP_DEVINSTALL_PARAMS_W  // SP_DEVINSTALL_PARAMS_W* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupDiGetDeviceInstallParamsW(IntPtr DeviceInfoSet, IntPtr DeviceInfoData, IntPtr DeviceInstallParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetDeviceInstallParamsW' -Namespace Win32 -PassThru
# $api::SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
#uselib "SETUPAPI.dll"
#func global SetupDiGetDeviceInstallParamsW "SetupDiGetDeviceInstallParamsW" wptr, wptr, wptr
; SetupDiGetDeviceInstallParamsW DeviceInfoSet, varptr(DeviceInfoData), varptr(DeviceInstallParams)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "wptr"
; DeviceInfoData : SP_DEVINFO_DATA* optional -> "wptr"
; DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetDeviceInstallParamsW "SetupDiGetDeviceInstallParamsW" sptr, var, var
; res = SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* optional -> "var"
; DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetDeviceInstallParamsW(HDEVINFO DeviceInfoSet, SP_DEVINFO_DATA* DeviceInfoData, SP_DEVINSTALL_PARAMS_W* DeviceInstallParams)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetDeviceInstallParamsW "SetupDiGetDeviceInstallParamsW" intptr, var, var
; res = SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
; DeviceInfoSet : HDEVINFO -> "intptr"
; DeviceInfoData : SP_DEVINFO_DATA* optional -> "var"
; DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetDeviceInstallParamsW = setupapi.NewProc("SetupDiGetDeviceInstallParamsW")
)

// DeviceInfoSet (HDEVINFO), DeviceInfoData (SP_DEVINFO_DATA* optional), DeviceInstallParams (SP_DEVINSTALL_PARAMS_W* in/out)
r1, _, err := procSetupDiGetDeviceInstallParamsW.Call(
	uintptr(DeviceInfoSet),
	uintptr(DeviceInfoData),
	uintptr(DeviceInstallParams),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetDeviceInstallParamsW(
  DeviceInfoSet: NativeInt;   // HDEVINFO
  DeviceInfoData: Pointer;   // SP_DEVINFO_DATA* optional
  DeviceInstallParams: Pointer   // SP_DEVINSTALL_PARAMS_W* in/out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetDeviceInstallParamsW';
result := DllCall("SETUPAPI\SetupDiGetDeviceInstallParamsW"
    , "Ptr", DeviceInfoSet   ; HDEVINFO
    , "Ptr", DeviceInfoData   ; SP_DEVINFO_DATA* optional
    , "Ptr", DeviceInstallParams   ; SP_DEVINSTALL_PARAMS_W* in/out
    , "Int")   ; return: BOOL
●SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams) = DLL("SETUPAPI.dll", "bool SetupDiGetDeviceInstallParamsW(int, void*, void*)")
# 呼び出し: SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
# DeviceInfoSet : HDEVINFO -> "int"
# DeviceInfoData : SP_DEVINFO_DATA* optional -> "void*"
# DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "setupapi" fn SetupDiGetDeviceInstallParamsW(
    DeviceInfoSet: isize, // HDEVINFO
    DeviceInfoData: [*c]SP_DEVINFO_DATA, // SP_DEVINFO_DATA* optional
    DeviceInstallParams: [*c]SP_DEVINSTALL_PARAMS_W // SP_DEVINSTALL_PARAMS_W* in/out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetupDiGetDeviceInstallParamsW(
    DeviceInfoSet: int,  # HDEVINFO
    DeviceInfoData: ptr SP_DEVINFO_DATA,  # SP_DEVINFO_DATA* optional
    DeviceInstallParams: ptr SP_DEVINSTALL_PARAMS_W  # SP_DEVINSTALL_PARAMS_W* in/out
): int32 {.importc: "SetupDiGetDeviceInstallParamsW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetDeviceInstallParamsW(
    ptrdiff_t DeviceInfoSet,   // HDEVINFO
    SP_DEVINFO_DATA* DeviceInfoData,   // SP_DEVINFO_DATA* optional
    SP_DEVINSTALL_PARAMS_W* DeviceInstallParams   // SP_DEVINSTALL_PARAMS_W* in/out
);
ccall((:SetupDiGetDeviceInstallParamsW, "SETUPAPI.dll"), stdcall, Int32,
      (Int, Ptr{SP_DEVINFO_DATA}, Ptr{SP_DEVINSTALL_PARAMS_W}),
      DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
# DeviceInfoSet : HDEVINFO -> Int
# DeviceInfoData : SP_DEVINFO_DATA* optional -> Ptr{SP_DEVINFO_DATA}
# DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> Ptr{SP_DEVINSTALL_PARAMS_W}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetDeviceInstallParamsW(
    intptr_t DeviceInfoSet,
    void* DeviceInfoData,
    void* DeviceInstallParams);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
-- DeviceInfoSet : HDEVINFO
-- DeviceInfoData : SP_DEVINFO_DATA* optional
-- DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetDeviceInstallParamsW = lib.func('__stdcall', 'SetupDiGetDeviceInstallParamsW', 'int32_t', ['intptr_t', 'void *', 'void *']);
// SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
// DeviceInfoSet : HDEVINFO -> 'intptr_t'
// DeviceInfoData : SP_DEVINFO_DATA* optional -> 'void *'
// DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiGetDeviceInstallParamsW: { parameters: ["isize", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
// DeviceInfoSet : HDEVINFO -> "isize"
// DeviceInfoData : SP_DEVINFO_DATA* optional -> "pointer"
// DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetDeviceInstallParamsW(
    intptr_t DeviceInfoSet,
    void* DeviceInfoData,
    void* DeviceInstallParams);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetDeviceInstallParamsW(DeviceInfoSet, DeviceInfoData, DeviceInstallParams);
// DeviceInfoSet : HDEVINFO
// DeviceInfoData : SP_DEVINFO_DATA* optional
// DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/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, W32APIOptions.UNICODE_OPTIONS);
    boolean SetupDiGetDeviceInstallParamsW(
        long DeviceInfoSet,   // HDEVINFO
        Pointer DeviceInfoData,   // SP_DEVINFO_DATA* optional
        Pointer DeviceInstallParams   // SP_DEVINSTALL_PARAMS_W* in/out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiGetDeviceInstallParamsW = SetupDiGetDeviceInstallParamsW(
    DeviceInfoSet : LibC::SSizeT,   # HDEVINFO
    DeviceInfoData : SP_DEVINFO_DATA*,   # SP_DEVINFO_DATA* optional
    DeviceInstallParams : SP_DEVINSTALL_PARAMS_W*   # SP_DEVINSTALL_PARAMS_W* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupDiGetDeviceInstallParamsWNative = Int32 Function(IntPtr, Pointer<Void>, Pointer<Void>);
typedef SetupDiGetDeviceInstallParamsWDart = int Function(int, Pointer<Void>, Pointer<Void>);
final SetupDiGetDeviceInstallParamsW = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetDeviceInstallParamsWNative, SetupDiGetDeviceInstallParamsWDart>('SetupDiGetDeviceInstallParamsW');
// DeviceInfoSet : HDEVINFO -> IntPtr
// DeviceInfoData : SP_DEVINFO_DATA* optional -> Pointer<Void>
// DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetDeviceInstallParamsW(
  DeviceInfoSet: NativeInt;   // HDEVINFO
  DeviceInfoData: Pointer;   // SP_DEVINFO_DATA* optional
  DeviceInstallParams: Pointer   // SP_DEVINSTALL_PARAMS_W* in/out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetDeviceInstallParamsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiGetDeviceInstallParamsW"
  c_SetupDiGetDeviceInstallParamsW :: CIntPtr -> Ptr () -> Ptr () -> IO CInt
-- DeviceInfoSet : HDEVINFO -> CIntPtr
-- DeviceInfoData : SP_DEVINFO_DATA* optional -> Ptr ()
-- DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdigetdeviceinstallparamsw =
  foreign "SetupDiGetDeviceInstallParamsW"
    (intptr_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* DeviceInfoSet : HDEVINFO -> intptr_t *)
(* DeviceInfoData : SP_DEVINFO_DATA* optional -> (ptr void) *)
(* DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiGetDeviceInstallParamsW" setup-di-get-device-install-params-w :convention :stdcall) :int32
  (device-info-set :int64)   ; HDEVINFO
  (device-info-data :pointer)   ; SP_DEVINFO_DATA* optional
  (device-install-params :pointer))   ; SP_DEVINSTALL_PARAMS_W* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiGetDeviceInstallParamsW = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetDeviceInstallParamsW(LPARAM DeviceInfoSet, LPVOID DeviceInfoData, LPVOID DeviceInstallParams)');
# my $ret = $SetupDiGetDeviceInstallParamsW->Call($DeviceInfoSet, $DeviceInfoData, $DeviceInstallParams);
# DeviceInfoSet : HDEVINFO -> LPARAM
# DeviceInfoData : SP_DEVINFO_DATA* optional -> LPVOID
# DeviceInstallParams : SP_DEVINSTALL_PARAMS_W* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型