ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetClassDescriptionExA
SetupDiGetClassDescriptionExA
関数リモート対応でセットアップクラスの説明文字列を取得する。
シグネチャ
// SETUPAPI.dll (ANSI / -A)
#include <windows.h>
BOOL SetupDiGetClassDescriptionExA(
const GUID* ClassGuid,
LPSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize, // optional
LPCSTR MachineName, // optional
void* Reserved // optional
);パラメーター
| 名前 | 型 | 方向 |
|---|---|---|
| ClassGuid | GUID* | in |
| ClassDescription | LPSTR | out |
| ClassDescriptionSize | DWORD | in |
| RequiredSize | DWORD* | outoptional |
| MachineName | LPCSTR | inoptional |
| Reserved | void* | optional |
戻り値の型: BOOL
各言語での呼び出し定義
// SETUPAPI.dll (ANSI / -A)
#include <windows.h>
BOOL SetupDiGetClassDescriptionExA(
const GUID* ClassGuid,
LPSTR ClassDescription,
DWORD ClassDescriptionSize,
DWORD* RequiredSize, // optional
LPCSTR MachineName, // optional
void* Reserved // optional
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassDescriptionExA(
ref Guid ClassGuid, // GUID*
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassDescription, // LPSTR out
uint ClassDescriptionSize, // DWORD
IntPtr RequiredSize, // DWORD* optional, out
[MarshalAs(UnmanagedType.LPStr)] string MachineName, // LPCSTR optional
IntPtr Reserved // void* optional
);<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetClassDescriptionExA(
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
<MarshalAs(UnmanagedType.LPStr)> MachineName As String, ' LPCSTR optional
Reserved As IntPtr ' void* optional
) As Boolean
End Function' ClassGuid : GUID*
' ClassDescription : LPSTR out
' ClassDescriptionSize : DWORD
' RequiredSize : DWORD* optional, out
' MachineName : LPCSTR optional
' Reserved : void* optional
Declare PtrSafe Function SetupDiGetClassDescriptionExA Lib "setupapi" ( _
ByVal ClassGuid As LongPtr, _
ByVal ClassDescription As String, _
ByVal ClassDescriptionSize As Long, _
ByVal RequiredSize As LongPtr, _
ByVal MachineName As String, _
ByVal Reserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
SetupDiGetClassDescriptionExA = ctypes.windll.setupapi.SetupDiGetClassDescriptionExA
SetupDiGetClassDescriptionExA.restype = wintypes.BOOL
SetupDiGetClassDescriptionExA.argtypes = [
ctypes.c_void_p, # ClassGuid : GUID*
wintypes.LPSTR, # ClassDescription : LPSTR out
wintypes.DWORD, # ClassDescriptionSize : DWORD
ctypes.POINTER(wintypes.DWORD), # RequiredSize : DWORD* optional, out
wintypes.LPCSTR, # MachineName : LPCSTR 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')
SetupDiGetClassDescriptionExA = Fiddle::Function.new(
lib['SetupDiGetClassDescriptionExA'],
[
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_VOIDP, # MachineName : LPCSTR optional
Fiddle::TYPE_VOIDP, # Reserved : void* optional
],
Fiddle::TYPE_INT)#[link(name = "setupapi")]
extern "system" {
fn SetupDiGetClassDescriptionExA(
ClassGuid: *const GUID, // GUID*
ClassDescription: *mut u8, // LPSTR out
ClassDescriptionSize: u32, // DWORD
RequiredSize: *mut u32, // DWORD* optional, out
MachineName: *const u8, // LPCSTR 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.Ansi, SetLastError = true)]
public static extern bool SetupDiGetClassDescriptionExA(ref Guid ClassGuid, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ClassDescription, uint ClassDescriptionSize, IntPtr RequiredSize, [MarshalAs(UnmanagedType.LPStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassDescriptionExA' -Namespace Win32 -PassThru
# $api::SetupDiGetClassDescriptionExA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)#uselib "SETUPAPI.dll"
#func global SetupDiGetClassDescriptionExA "SetupDiGetClassDescriptionExA" sptr, sptr, sptr, sptr, sptr, sptr
; SetupDiGetClassDescriptionExA varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize), MachineName, Reserved ; 戻り値は stat
; ClassGuid : GUID* -> "sptr"
; ClassDescription : LPSTR out -> "sptr"
; ClassDescriptionSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; MachineName : LPCSTR optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionExA "SetupDiGetClassDescriptionExA" var, var, int, var, str, sptr ; res = SetupDiGetClassDescriptionExA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; MachineName : LPCSTR optional -> "str" ; Reserved : void* optional -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionExA "SetupDiGetClassDescriptionExA" sptr, sptr, int, sptr, str, sptr ; res = SetupDiGetClassDescriptionExA(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize), MachineName, Reserved) ; ClassGuid : GUID* -> "sptr" ; ClassDescription : LPSTR out -> "sptr" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "sptr" ; MachineName : LPCSTR optional -> "str" ; Reserved : void* optional -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL SetupDiGetClassDescriptionExA(GUID* ClassGuid, LPSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize, LPCSTR MachineName, void* Reserved) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionExA "SetupDiGetClassDescriptionExA" var, var, int, var, str, intptr ; res = SetupDiGetClassDescriptionExA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved) ; ClassGuid : GUID* -> "var" ; ClassDescription : LPSTR out -> "var" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "var" ; MachineName : LPCSTR optional -> "str" ; Reserved : void* optional -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL SetupDiGetClassDescriptionExA(GUID* ClassGuid, LPSTR ClassDescription, DWORD ClassDescriptionSize, DWORD* RequiredSize, LPCSTR MachineName, void* Reserved) #uselib "SETUPAPI.dll" #cfunc global SetupDiGetClassDescriptionExA "SetupDiGetClassDescriptionExA" intptr, intptr, int, intptr, str, intptr ; res = SetupDiGetClassDescriptionExA(varptr(ClassGuid), varptr(ClassDescription), ClassDescriptionSize, varptr(RequiredSize), MachineName, Reserved) ; ClassGuid : GUID* -> "intptr" ; ClassDescription : LPSTR out -> "intptr" ; ClassDescriptionSize : DWORD -> "int" ; RequiredSize : DWORD* optional, out -> "intptr" ; MachineName : LPCSTR optional -> "str" ; Reserved : void* optional -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
procSetupDiGetClassDescriptionExA = setupapi.NewProc("SetupDiGetClassDescriptionExA")
)
// ClassGuid (GUID*), ClassDescription (LPSTR out), ClassDescriptionSize (DWORD), RequiredSize (DWORD* optional, out), MachineName (LPCSTR optional), Reserved (void* optional)
r1, _, err := procSetupDiGetClassDescriptionExA.Call(
uintptr(ClassGuid),
uintptr(ClassDescription),
uintptr(ClassDescriptionSize),
uintptr(RequiredSize),
uintptr(unsafe.Pointer(windows.BytePtrFromString(MachineName))),
uintptr(Reserved),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction SetupDiGetClassDescriptionExA(
ClassGuid: PGUID; // GUID*
ClassDescription: PAnsiChar; // LPSTR out
ClassDescriptionSize: DWORD; // DWORD
RequiredSize: Pointer; // DWORD* optional, out
MachineName: PAnsiChar; // LPCSTR optional
Reserved: Pointer // void* optional
): BOOL; stdcall;
external 'SETUPAPI.dll' name 'SetupDiGetClassDescriptionExA';result := DllCall("SETUPAPI\SetupDiGetClassDescriptionExA"
, "Ptr", ClassGuid ; GUID*
, "Ptr", ClassDescription ; LPSTR out
, "UInt", ClassDescriptionSize ; DWORD
, "Ptr", RequiredSize ; DWORD* optional, out
, "AStr", MachineName ; LPCSTR optional
, "Ptr", Reserved ; void* optional
, "Int") ; return: BOOL●SetupDiGetClassDescriptionExA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved) = DLL("SETUPAPI.dll", "bool SetupDiGetClassDescriptionExA(void*, char*, dword, void*, char*, void*)")
# 呼び出し: SetupDiGetClassDescriptionExA(ClassGuid, ClassDescription, ClassDescriptionSize, RequiredSize, MachineName, Reserved)
# ClassGuid : GUID* -> "void*"
# ClassDescription : LPSTR out -> "char*"
# ClassDescriptionSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# MachineName : LPCSTR optional -> "char*"
# Reserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。