ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassDescriptionW
SetupDiGetClassDescriptionW
関数指定セットアップクラスの説明文字列を取得する。
シグネチャ
// SETUPAPI.dll (Unicode / -W)
#include <windows.h>
BOOL SetupDiGetClassDescriptionW(
const GUID* ClassGuid,
LPWSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ClassGuid | GUID* | in | 説明文を取得する対象のセットアップクラスGUID。 |
| ClassDescription | LPWSTR | out | クラスの説明文字列を受け取るバッファ(Unicode)。 |
| ClassDescriptionSize | DWORD | in | ClassDescriptionバッファの文字数。終端NUL含む。 |
| RequiredSize | DWORD* | outoptional | 説明文に必要な文字数を受け取るポインタ。不足判定に使う。NULL可。 |
戻り値の型: BOOL
各言語での呼び出し定義
// SETUPAPI.dll (Unicode / -W)
#include <windows.h>
BOOL SetupDiGetClassDescriptionW(
const GUID* ClassGuid,
LPWSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassDescriptionW(
ref Guid ClassGuid, // GUID*
[MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClassDescription, // LPWSTR out
uint ClassDescriptionSize, // DWORD
IntPtr RequiredSize // DWORD* optional, out
);<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassDescriptionW(
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
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' ClassGuid : GUID*
' ClassDescription : LPWSTR out
' ClassDescriptionSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetClassDescriptionW Lib "setupapi" ( _
ByVal ClassGuid As LongPtr, _
ByVal ClassDescription As LongPtr, _
ByVal ClassDescriptionSize As Long, _
ByVal RequiredSize 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
SetupDiGetClassDescriptionW = ctypes.windll.setupapi.SetupDiGetClassDescriptionW
SetupDiGetClassDescriptionW.restype = wintypes.BOOL
SetupDiGetClassDescriptionW.argtypes = [
ctypes.c_void_p, # ClassGuid : GUID*
wintypes.LPWSTR, # ClassDescription : LPWSTR out
wintypes.DWORD, # ClassDescriptionSize : DWORD
ctypes.POINTER(wintypes.DWORD), # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetClassDescriptionW = Fiddle::Function.new(
lib['SetupDiGetClassDescriptionW'],
[
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_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "setupapi")]
extern "system" {
fn SetupDiGetClassDescriptionW(
ClassGuid: *const GUID, // GUID*
ClassDescription: *mut u16, // LPWSTR out
ClassDescriptionSize: u32, // DWORD
RequiredSize: *mut u32 // DWORD* optional, 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 SetupDiGetClassDescriptionW(ref Guid ClassGuid, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ClassDescription, uint ClassDescriptionSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassDescriptionW' -Namespace Win32 -PassThru
# $api::SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)#uselib "SETUPAPI.dll"
#func global SetupDiGetClassDescriptionW "SetupDiGetClassDescriptionW" wptr, wptr, wptr, wptr
; SetupDiGetClassDescriptionW varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize) ; 戻り値は stat
; ClassGuid : GUID* -> "wptr"
; ClassDescription : LPWSTR out -> "wptr"
; ClassDescriptionSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionW "SetupDiGetClassDescriptionW" var, var, int, var ; res = SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPWSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionW "SetupDiGetClassDescriptionW" sptr, sptr, int, sptr ; res = SetupDiGetClassDescriptionW(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize)) ; ClassGuid : GUID* -> "sptr" ; ClassDescription : LPWSTR out -> "sptr" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SetupDiGetClassDescriptionW(GUID* ClassGuid, LPWSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionW "SetupDiGetClassDescriptionW" var, var, int, var ; res = SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPWSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupDiGetClassDescriptionW(GUID* ClassGuid, LPWSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionW "SetupDiGetClassDescriptionW" intptr, intptr, int, intptr ; res = SetupDiGetClassDescriptionW(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize)) ; ClassGuid : GUID* -> "intptr" ; ClassDescription : LPWSTR out -> "intptr" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
procSetupDiGetClassDescriptionW = setupapi.NewProc("SetupDiGetClassDescriptionW")
)
// ClassGuid (GUID*), ClassDescription (LPWSTR out), ClassDescriptionSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupDiGetClassDescriptionW.Call(
uintptr(ClassGuid),
uintptr(ClassDescription),
uintptr(ClassDescriptionSize),
uintptr(RequiredSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetupDiGetClassDescriptionW(
ClassGuid: PGUID; // GUID*
ClassDescription: PWideChar; // LPWSTR out
ClassDescriptionSize: DWORD; // DWORD
RequiredSize: Pointer // DWORD* optional, out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionW';result := DllCall("SETUPAPI\SetupDiGetClassDescriptionW"
, "Ptr", ClassGuid ; GUID*
, "Ptr", ClassDescription ; LPWSTR out
, "UInt", ClassDescriptionSize ; DWORD
, "Ptr", RequiredSize ; DWORD* optional, out
, "Int") ; return: BOOL●SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupDiGetClassDescriptionW(void*, char*, dword, void*)")
# 呼び出し: SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
# ClassGuid : GUID* -> "void*"
# ClassDescription : LPWSTR out -> "char*"
# ClassDescriptionSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "setupapi" fn SetupDiGetClassDescriptionW(
ClassGuid: [*c]GUID, // GUID*
ClassDescription: [*c]u16, // LPWSTR out
ClassDescriptionSize: u32, // DWORD
RequiredSize: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc SetupDiGetClassDescriptionW(
ClassGuid: ptr GUID, # GUID*
ClassDescription: ptr uint16, # LPWSTR out
ClassDescriptionSize: uint32, # DWORD
RequiredSize: ptr uint32 # DWORD* optional, out
): int32 {.importc: "SetupDiGetClassDescriptionW", stdcall, dynlib: "SETUPAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetClassDescriptionW(
GUID* ClassGuid, // GUID*
wchar* ClassDescription, // LPWSTR out
uint ClassDescriptionSize, // DWORD
uint* RequiredSize // DWORD* optional, out
);ccall((:SetupDiGetClassDescriptionW, "SETUPAPI.dll"), stdcall, Int32,
(Ptr{GUID}, Ptr{UInt16}, UInt32, Ptr{UInt32}),
ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
# ClassGuid : GUID* -> Ptr{GUID}
# ClassDescription : LPWSTR out -> Ptr{UInt16}
# ClassDescriptionSize : DWORD -> UInt32
# RequiredSize : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetClassDescriptionW(
void* ClassGuid,
uint16_t* ClassDescription,
uint32_t ClassDescriptionSize,
uint32_t* RequiredSize);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
-- ClassGuid : GUID*
-- ClassDescription : LPWSTR out
-- ClassDescriptionSize : DWORD
-- RequiredSize : DWORD* optional, 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 SetupDiGetClassDescriptionW = lib.func('__stdcall', 'SetupDiGetClassDescriptionW', 'int32_t', ['void *', 'uint16_t *', 'uint32_t', 'uint32_t *']);
// SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
// ClassGuid : GUID* -> 'void *'
// ClassDescription : LPWSTR out -> 'uint16_t *'
// ClassDescriptionSize : DWORD -> 'uint32_t'
// RequiredSize : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SETUPAPI.dll", {
SetupDiGetClassDescriptionW: { parameters: ["pointer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
// ClassGuid : GUID* -> "pointer"
// ClassDescription : LPWSTR out -> "buffer"
// ClassDescriptionSize : DWORD -> "u32"
// RequiredSize : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetClassDescriptionW(
void* ClassGuid,
uint16_t* ClassDescription,
uint32_t ClassDescriptionSize,
uint32_t* RequiredSize);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetClassDescriptionW(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize);
// ClassGuid : GUID*
// ClassDescription : LPWSTR out
// ClassDescriptionSize : DWORD
// RequiredSize : 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, W32APIOptions.UNICODE_OPTIONS);
boolean SetupDiGetClassDescriptionW(
Pointer ClassGuid, // GUID*
char[] ClassDescription, // LPWSTR out
int ClassDescriptionSize, // DWORD
IntByReference RequiredSize // DWORD* optional, out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("setupapi")]
lib LibSETUPAPI
fun SetupDiGetClassDescriptionW = SetupDiGetClassDescriptionW(
ClassGuid : GUID*, # GUID*
ClassDescription : UInt16*, # LPWSTR out
ClassDescriptionSize : UInt32, # DWORD
RequiredSize : 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 SetupDiGetClassDescriptionWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, Pointer<Uint32>);
typedef SetupDiGetClassDescriptionWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Uint32>);
final SetupDiGetClassDescriptionW = DynamicLibrary.open('SETUPAPI.dll')
.lookupFunction<SetupDiGetClassDescriptionWNative, SetupDiGetClassDescriptionWDart>('SetupDiGetClassDescriptionW');
// ClassGuid : GUID* -> Pointer<Void>
// ClassDescription : LPWSTR out -> Pointer<Utf16>
// ClassDescriptionSize : DWORD -> Uint32
// RequiredSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetupDiGetClassDescriptionW(
ClassGuid: PGUID; // GUID*
ClassDescription: PWideChar; // LPWSTR out
ClassDescriptionSize: DWORD; // DWORD
RequiredSize: Pointer // DWORD* optional, out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetupDiGetClassDescriptionW"
c_SetupDiGetClassDescriptionW :: Ptr () -> CWString -> Word32 -> Ptr Word32 -> IO CInt
-- ClassGuid : GUID* -> Ptr ()
-- ClassDescription : LPWSTR out -> CWString
-- ClassDescriptionSize : DWORD -> Word32
-- RequiredSize : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setupdigetclassdescriptionw =
foreign "SetupDiGetClassDescriptionW"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* ClassGuid : GUID* -> (ptr void) *)
(* ClassDescription : LPWSTR out -> (ptr uint16_t) *)
(* ClassDescriptionSize : DWORD -> uint32_t *)
(* RequiredSize : 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 ("SetupDiGetClassDescriptionW" setup-di-get-class-description-w :convention :stdcall) :int32
(class-guid :pointer) ; GUID*
(class-description :pointer) ; LPWSTR out
(class-description-size :uint32) ; DWORD
(required-size :pointer)) ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $SetupDiGetClassDescriptionW = Win32::API::More->new('SETUPAPI',
'BOOL SetupDiGetClassDescriptionW(LPVOID ClassGuid, LPWSTR ClassDescription, DWORD ClassDescriptionSize, LPVOID RequiredSize)');
# my $ret = $SetupDiGetClassDescriptionW->Call($ClassGuid, $ClassDescription, $ClassDescriptionSize, $RequiredSize);
# ClassGuid : GUID* -> LPVOID
# ClassDescription : LPWSTR out -> LPWSTR
# ClassDescriptionSize : DWORD -> DWORD
# RequiredSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f SetupDiGetClassDescriptionA (ANSI版) — 指定セットアップクラスの説明文字列を取得する。
類似 API
- f SetupDiGetClassDescriptionExW — リモート対応でセットアップクラスの説明文字列を取得する。