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

SetupDiGetClassDescriptionExW

関数
リモート対応でセットアップクラスの説明文字列を取得する。
DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetupDiGetClassDescriptionExW(
    const GUID* ClassGuid,
    LPWSTR ClassDescription,
    DWORD ClassDescriptionSize,
    DWORD* RequiredSize,   // optional
    LPCWSTR MachineName,   // optional
    void* Reserved   // optional
);

パラメーター

名前方向
ClassGuidGUID*in
ClassDescriptionLPWSTRout
ClassDescriptionSizeDWORDin
RequiredSizeDWORD*outoptional
MachineNameLPCWSTRinoptional
Reservedvoid*optional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupDiGetClassDescriptionExW(
    const GUID* ClassGuid,
    LPWSTR ClassDescription,
    DWORD ClassDescriptionSize,
    DWORD* RequiredSize,   // optional
    LPCWSTR MachineName,   // optional
    void* Reserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassDescriptionExW(
    ref Guid ClassGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClassDescription,   // LPWSTR out
    uint ClassDescriptionSize,   // DWORD
    IntPtr RequiredSize,   // DWORD* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] string MachineName,   // LPCWSTR optional
    IntPtr Reserved   // void* optional
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassDescriptionExW(
    ByRef ClassGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> ClassDescription As System.Text.StringBuilder,   ' LPWSTR out
    ClassDescriptionSize As UInteger,   ' DWORD
    RequiredSize As IntPtr,   ' DWORD* optional, out
    <MarshalAs(UnmanagedType.LPWStr)> MachineName As String,   ' LPCWSTR optional
    Reserved As IntPtr   ' void* optional
) As Boolean
End Function
' ClassGuid : GUID*
' ClassDescription : LPWSTR out
' ClassDescriptionSize : DWORD
' RequiredSize : DWORD* optional, out
' MachineName : LPCWSTR optional
' Reserved : void* optional
Declare PtrSafe Function SetupDiGetClassDescriptionExW Lib "setupapi" ( _
    ByVal ClassGuid As LongPtr, _
    ByVal ClassDescription As LongPtr, _
    ByVal ClassDescriptionSize As Long, _
    ByVal RequiredSize As LongPtr, _
    ByVal MachineName As LongPtr, _
    ByVal Reserved 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

SetupDiGetClassDescriptionExW = ctypes.windll.setupapi.SetupDiGetClassDescriptionExW
SetupDiGetClassDescriptionExW.restype = wintypes.BOOL
SetupDiGetClassDescriptionExW.argtypes = [
    ctypes.c_void_p,  # ClassGuid : GUID*
    wintypes.LPWSTR,  # ClassDescription : LPWSTR out
    wintypes.DWORD,  # ClassDescriptionSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
    wintypes.LPCWSTR,  # MachineName : LPCWSTR 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')
SetupDiGetClassDescriptionExW = Fiddle::Function.new(
  lib['SetupDiGetClassDescriptionExW'],
  [
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID*
    Fiddle::TYPE_VOIDP,  # ClassDescription : LPWSTR out
    -Fiddle::TYPE_INT,  # ClassDescriptionSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # MachineName : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetClassDescriptionExW(
        ClassGuid: *const GUID,  // GUID*
        ClassDescription: *mut u16,  // LPWSTR out
        ClassDescriptionSize: u32,  // DWORD
        RequiredSize: *mut u32,  // DWORD* optional, out
        MachineName: *const u16,  // LPCWSTR optional
        Reserved: *mut ()  // void* optional
    ) -> 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 SetupDiGetClassDescriptionExW(ref Guid ClassGuid, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClassDescription, uint ClassDescriptionSize, IntPtr RequiredSize, [MarshalAs(UnmanagedType.LPWStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassDescriptionExW' -Namespace Win32 -PassThru
# $api::SetupDiGetClassDescriptionExW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)
#uselib "SETUPAPI.dll"
#func global SetupDiGetClassDescriptionExW "SetupDiGetClassDescriptionExW" wptr, wptr, wptr, wptr, wptr, wptr
; SetupDiGetClassDescriptionExW varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize), MachineName, Reserved   ; 戻り値は stat
; ClassGuid : GUID* -> "wptr"
; ClassDescription : LPWSTR out -> "wptr"
; ClassDescriptionSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; MachineName : LPCWSTR optional -> "wptr"
; Reserved : void* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassDescriptionExW "SetupDiGetClassDescriptionExW" var, var, int, var, wstr, sptr
; res = SetupDiGetClassDescriptionExW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)
; ClassGuid : GUID* -> "var"
; ClassDescription : LPWSTR out -> "var"
; ClassDescriptionSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetClassDescriptionExW(GUID* ClassGuid, LPWSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize, LPCWSTR MachineName, void* Reserved)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassDescriptionExW "SetupDiGetClassDescriptionExW" var, var, int, var, wstr, intptr
; res = SetupDiGetClassDescriptionExW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)
; ClassGuid : GUID* -> "var"
; ClassDescription : LPWSTR out -> "var"
; ClassDescriptionSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; MachineName : LPCWSTR optional -> "wstr"
; Reserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetClassDescriptionExW = setupapi.NewProc("SetupDiGetClassDescriptionExW")
)

// ClassGuid (GUID*), ClassDescription (LPWSTR out), ClassDescriptionSize (DWORD), RequiredSize (DWORD* optional, out), MachineName (LPCWSTR optional), Reserved (void* optional)
r1, _, err := procSetupDiGetClassDescriptionExW.Call(
	uintptr(ClassGuid),
	uintptr(ClassDescription),
	uintptr(ClassDescriptionSize),
	uintptr(RequiredSize),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(MachineName))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetClassDescriptionExW(
  ClassGuid: PGUID;   // GUID*
  ClassDescription: PWideChar;   // LPWSTR out
  ClassDescriptionSize: DWORD;   // DWORD
  RequiredSize: Pointer;   // DWORD* optional, out
  MachineName: PWideChar;   // LPCWSTR optional
  Reserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionExW';
result := DllCall("SETUPAPI\SetupDiGetClassDescriptionExW"
    , "Ptr", ClassGuid   ; GUID*
    , "Ptr", ClassDescription   ; LPWSTR out
    , "UInt", ClassDescriptionSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "WStr", MachineName   ; LPCWSTR optional
    , "Ptr", Reserved   ; void* optional
    , "Int")   ; return: BOOL
●SetupDiGetClassDescriptionExW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved) = DLL("SETUPAPI.dll", "bool SetupDiGetClassDescriptionExW(void*, char*, dword, void*, char*, void*)")
# 呼び出し: SetupDiGetClassDescriptionExW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)
# ClassGuid : GUID* -> "void*"
# ClassDescription : LPWSTR out -> "char*"
# ClassDescriptionSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# MachineName : LPCWSTR optional -> "char*"
# Reserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。