ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassDescriptionA
SetupDiGetClassDescriptionA
関数指定セットアップクラスの説明文字列を取得する。
シグネチャ
// SETUPAPI.dll (ANSI / -A)
#include <windows.h>
BOOL SetupDiGetClassDescriptionA(
const GUID* ClassGuid,
LPSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ClassGuid | GUID* | in | 説明文を取得する対象のセットアップクラスGUID。 |
| ClassDescription | LPSTR | out | クラスの説明文字列を受け取るバッファ(ANSI)。 |
| ClassDescriptionSize | DWORD | in | ClassDescriptionバッファの文字数。終端NUL含む。 |
| RequiredSize | DWORD* | outoptional | 説明文に必要な文字数を受け取るポインタ。不足判定に使う。NULL可。 |
戻り値の型: BOOL
各言語での呼び出し定義
// SETUPAPI.dll (ANSI / -A)
#include <windows.h>
BOOL SetupDiGetClassDescriptionA(
const GUID* ClassGuid,
LPSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassDescriptionA(
ref Guid ClassGuid, // GUID*
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassDescription, // LPSTR out
uint ClassDescriptionSize, // DWORD
IntPtr RequiredSize // DWORD* optional, out
);<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassDescriptionA(
ByRef ClassGuid As Guid, ' GUID*
<MarshalAs(UnmanagedType.LPStr)> ClassDescription As System.Text.StringBuilder, ' LPSTR out
ClassDescriptionSize As UInteger, ' DWORD
RequiredSize As IntPtr ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' ClassGuid : GUID*
' ClassDescription : LPSTR out
' ClassDescriptionSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetClassDescriptionA Lib "setupapi" ( _
ByVal ClassGuid As LongPtr, _
ByVal ClassDescription As String, _
ByVal ClassDescriptionSize As Long, _
ByVal RequiredSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetupDiGetClassDescriptionA = ctypes.windll.setupapi.SetupDiGetClassDescriptionA
SetupDiGetClassDescriptionA.restype = wintypes.BOOL
SetupDiGetClassDescriptionA.argtypes = [
ctypes.c_void_p, # ClassGuid : GUID*
wintypes.LPSTR, # ClassDescription : LPSTR 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')
SetupDiGetClassDescriptionA = Fiddle::Function.new(
lib['SetupDiGetClassDescriptionA'],
[
Fiddle::TYPE_VOIDP, # ClassGuid : GUID*
Fiddle::TYPE_VOIDP, # ClassDescription : LPSTR out
-Fiddle::TYPE_INT, # ClassDescriptionSize : DWORD
Fiddle::TYPE_VOIDP, # RequiredSize : DWORD* optional, out
],
Fiddle::TYPE_INT)#[link(name = "setupapi")]
extern "system" {
fn SetupDiGetClassDescriptionA(
ClassGuid: *const GUID, // GUID*
ClassDescription: *mut u8, // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool SetupDiGetClassDescriptionA(ref Guid ClassGuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassDescription, uint ClassDescriptionSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassDescriptionA' -Namespace Win32 -PassThru
# $api::SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)#uselib "SETUPAPI.dll"
#func global SetupDiGetClassDescriptionA "SetupDiGetClassDescriptionA" sptr, sptr, sptr, sptr
; SetupDiGetClassDescriptionA varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize) ; 戻り値は stat
; ClassGuid : GUID* -> "sptr"
; ClassDescription : LPSTR out -> "sptr"
; ClassDescriptionSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionA "SetupDiGetClassDescriptionA" var, var, int, var ; res = SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionA "SetupDiGetClassDescriptionA" sptr, sptr, int, sptr ; res = SetupDiGetClassDescriptionA(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize)) ; ClassGuid : GUID* -> "sptr" ; ClassDescription : LPSTR out -> "sptr" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SetupDiGetClassDescriptionA(GUID* ClassGuid, LPSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionA "SetupDiGetClassDescriptionA" var, var, int, var ; res = SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupDiGetClassDescriptionA(GUID* ClassGuid, LPSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionA "SetupDiGetClassDescriptionA" intptr, intptr, int, intptr ; res = SetupDiGetClassDescriptionA(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize)) ; ClassGuid : GUID* -> "intptr" ; ClassDescription : LPSTR 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")
procSetupDiGetClassDescriptionA = setupapi.NewProc("SetupDiGetClassDescriptionA")
)
// ClassGuid (GUID*), ClassDescription (LPSTR out), ClassDescriptionSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupDiGetClassDescriptionA.Call(
uintptr(ClassGuid),
uintptr(ClassDescription),
uintptr(ClassDescriptionSize),
uintptr(RequiredSize),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetupDiGetClassDescriptionA(
ClassGuid: PGUID; // GUID*
ClassDescription: PAnsiChar; // LPSTR out
ClassDescriptionSize: DWORD; // DWORD
RequiredSize: Pointer // DWORD* optional, out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionA';result := DllCall("SETUPAPI\SetupDiGetClassDescriptionA"
, "Ptr", ClassGuid ; GUID*
, "Ptr", ClassDescription ; LPSTR out
, "UInt", ClassDescriptionSize ; DWORD
, "Ptr", RequiredSize ; DWORD* optional, out
, "Int") ; return: BOOL●SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupDiGetClassDescriptionA(void*, char*, dword, void*)")
# 呼び出し: SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
# ClassGuid : GUID* -> "void*"
# ClassDescription : LPSTR out -> "char*"
# ClassDescriptionSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "setupapi" fn SetupDiGetClassDescriptionA(
ClassGuid: [*c]GUID, // GUID*
ClassDescription: [*c]u8, // LPSTR out
ClassDescriptionSize: u32, // DWORD
RequiredSize: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;proc SetupDiGetClassDescriptionA(
ClassGuid: ptr GUID, # GUID*
ClassDescription: ptr char, # LPSTR out
ClassDescriptionSize: uint32, # DWORD
RequiredSize: ptr uint32 # DWORD* optional, out
): int32 {.importc: "SetupDiGetClassDescriptionA", stdcall, dynlib: "SETUPAPI.dll".}pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetClassDescriptionA(
GUID* ClassGuid, // GUID*
char* ClassDescription, // LPSTR out
uint ClassDescriptionSize, // DWORD
uint* RequiredSize // DWORD* optional, out
);ccall((:SetupDiGetClassDescriptionA, "SETUPAPI.dll"), stdcall, Int32,
(Ptr{GUID}, Ptr{UInt8}, UInt32, Ptr{UInt32}),
ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
# ClassGuid : GUID* -> Ptr{GUID}
# ClassDescription : LPSTR out -> Ptr{UInt8}
# ClassDescriptionSize : DWORD -> UInt32
# RequiredSize : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetClassDescriptionA(
void* ClassGuid,
char* ClassDescription,
uint32_t ClassDescriptionSize,
uint32_t* RequiredSize);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
-- ClassGuid : GUID*
-- ClassDescription : LPSTR out
-- ClassDescriptionSize : DWORD
-- RequiredSize : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetClassDescriptionA = lib.func('__stdcall', 'SetupDiGetClassDescriptionA', 'int32_t', ['void *', 'char *', 'uint32_t', 'uint32_t *']);
// SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
// ClassGuid : GUID* -> 'void *'
// ClassDescription : LPSTR out -> 'char *'
// ClassDescriptionSize : DWORD -> 'uint32_t'
// RequiredSize : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SETUPAPI.dll", {
SetupDiGetClassDescriptionA: { parameters: ["pointer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize)
// ClassGuid : GUID* -> "pointer"
// ClassDescription : LPSTR out -> "buffer"
// ClassDescriptionSize : DWORD -> "u32"
// RequiredSize : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetClassDescriptionA(
void* ClassGuid,
char* ClassDescription,
uint32_t ClassDescriptionSize,
uint32_t* RequiredSize);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetClassDescriptionA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize);
// ClassGuid : GUID*
// ClassDescription : LPSTR 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.ASCII_OPTIONS);
boolean SetupDiGetClassDescriptionA(
Pointer ClassGuid, // GUID*
byte[] ClassDescription, // LPSTR out
int ClassDescriptionSize, // DWORD
IntByReference RequiredSize // DWORD* optional, out
);
}@[Link("setupapi")]
lib LibSETUPAPI
fun SetupDiGetClassDescriptionA = SetupDiGetClassDescriptionA(
ClassGuid : GUID*, # GUID*
ClassDescription : UInt8*, # LPSTR 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 SetupDiGetClassDescriptionANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Uint32>);
typedef SetupDiGetClassDescriptionADart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Uint32>);
final SetupDiGetClassDescriptionA = DynamicLibrary.open('SETUPAPI.dll')
.lookupFunction<SetupDiGetClassDescriptionANative, SetupDiGetClassDescriptionADart>('SetupDiGetClassDescriptionA');
// ClassGuid : GUID* -> Pointer<Void>
// ClassDescription : LPSTR out -> Pointer<Utf8>
// ClassDescriptionSize : DWORD -> Uint32
// RequiredSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function SetupDiGetClassDescriptionA(
ClassGuid: PGUID; // GUID*
ClassDescription: PAnsiChar; // LPSTR out
ClassDescriptionSize: DWORD; // DWORD
RequiredSize: Pointer // DWORD* optional, out
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "SetupDiGetClassDescriptionA"
c_SetupDiGetClassDescriptionA :: Ptr () -> CString -> Word32 -> Ptr Word32 -> IO CInt
-- ClassGuid : GUID* -> Ptr ()
-- ClassDescription : LPSTR out -> CString
-- ClassDescriptionSize : DWORD -> Word32
-- RequiredSize : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let setupdigetclassdescriptiona =
foreign "SetupDiGetClassDescriptionA"
((ptr void) @-> string @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* ClassGuid : GUID* -> (ptr void) *)
(* ClassDescription : LPSTR out -> string *)
(* 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 ("SetupDiGetClassDescriptionA" setup-di-get-class-description-a :convention :stdcall) :int32
(class-guid :pointer) ; GUID*
(class-description :pointer) ; LPSTR 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 $SetupDiGetClassDescriptionA = Win32::API::More->new('SETUPAPI',
'BOOL SetupDiGetClassDescriptionA(LPVOID ClassGuid, LPSTR ClassDescription, DWORD ClassDescriptionSize, LPVOID RequiredSize)');
# my $ret = $SetupDiGetClassDescriptionA->Call($ClassGuid, $ClassDescription, $ClassDescriptionSize, $RequiredSize);
# ClassGuid : GUID* -> LPVOID
# ClassDescription : LPSTR out -> LPSTR
# ClassDescriptionSize : DWORD -> DWORD
# RequiredSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f SetupDiGetClassDescriptionW (Unicode版) — 指定セットアップクラスの説明文字列を取得する。
類似 API
- f SetupDiGetClassDescriptionExA — リモート対応でセットアップクラスの説明文字列を取得する。