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

SetupDiGetClassImageListExA

関数
指定マシンのクラスイメージリストを取得する。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupDiGetClassImageListExA(
    SP_CLASSIMAGELIST_DATA* ClassImageListData,
    LPCSTR MachineName,   // optional
    void* Reserved   // optional
);

パラメーター

名前方向説明
ClassImageListDataSP_CLASSIMAGELIST_DATA*inoutクラスアイコンのイメージリストを受け取る構造体。cbSizeを設定して呼び出す。
MachineNameLPCSTRinoptional対象リモートコンピュータ名(ANSI)。NULL指定でローカルマシンを対象とする。
Reservedvoid*optional予約済み。NULLを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll  (ANSI / -A)
#include <windows.h>

BOOL SetupDiGetClassImageListExA(
    SP_CLASSIMAGELIST_DATA* ClassImageListData,
    LPCSTR MachineName,   // optional
    void* Reserved   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetClassImageListExA(
    IntPtr ClassImageListData,   // SP_CLASSIMAGELIST_DATA* in/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 SetupDiGetClassImageListExA(
    ClassImageListData As IntPtr,   ' SP_CLASSIMAGELIST_DATA* in/out
    <MarshalAs(UnmanagedType.LPStr)> MachineName As String,   ' LPCSTR optional
    Reserved As IntPtr   ' void* optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out
' MachineName : LPCSTR optional
' Reserved : void* optional
Declare PtrSafe Function SetupDiGetClassImageListExA Lib "setupapi" ( _
    ByVal ClassImageListData 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

SetupDiGetClassImageListExA = ctypes.windll.setupapi.SetupDiGetClassImageListExA
SetupDiGetClassImageListExA.restype = wintypes.BOOL
SetupDiGetClassImageListExA.argtypes = [
    ctypes.c_void_p,  # ClassImageListData : SP_CLASSIMAGELIST_DATA* in/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')
SetupDiGetClassImageListExA = Fiddle::Function.new(
  lib['SetupDiGetClassImageListExA'],
  [
    Fiddle::TYPE_VOIDP,  # ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out
    Fiddle::TYPE_VOIDP,  # MachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetClassImageListExA(
        ClassImageListData: *mut SP_CLASSIMAGELIST_DATA,  // SP_CLASSIMAGELIST_DATA* in/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 SetupDiGetClassImageListExA(IntPtr ClassImageListData, [MarshalAs(UnmanagedType.LPStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassImageListExA' -Namespace Win32 -PassThru
# $api::SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
#uselib "SETUPAPI.dll"
#func global SetupDiGetClassImageListExA "SetupDiGetClassImageListExA" sptr, sptr, sptr
; SetupDiGetClassImageListExA varptr(ClassImageListData), MachineName, Reserved   ; 戻り値は stat
; ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> "sptr"
; MachineName : LPCSTR optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassImageListExA "SetupDiGetClassImageListExA" var, str, sptr
; res = SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
; ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> "var"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetClassImageListExA(SP_CLASSIMAGELIST_DATA* ClassImageListData, LPCSTR MachineName, void* Reserved)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassImageListExA "SetupDiGetClassImageListExA" var, str, intptr
; res = SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
; ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> "var"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetClassImageListExA = setupapi.NewProc("SetupDiGetClassImageListExA")
)

// ClassImageListData (SP_CLASSIMAGELIST_DATA* in/out), MachineName (LPCSTR optional), Reserved (void* optional)
r1, _, err := procSetupDiGetClassImageListExA.Call(
	uintptr(ClassImageListData),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(MachineName))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetClassImageListExA(
  ClassImageListData: Pointer;   // SP_CLASSIMAGELIST_DATA* in/out
  MachineName: PAnsiChar;   // LPCSTR optional
  Reserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassImageListExA';
result := DllCall("SETUPAPI\SetupDiGetClassImageListExA"
    , "Ptr", ClassImageListData   ; SP_CLASSIMAGELIST_DATA* in/out
    , "AStr", MachineName   ; LPCSTR optional
    , "Ptr", Reserved   ; void* optional
    , "Int")   ; return: BOOL
●SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved) = DLL("SETUPAPI.dll", "bool SetupDiGetClassImageListExA(void*, char*, void*)")
# 呼び出し: SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
# ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> "void*"
# MachineName : LPCSTR optional -> "char*"
# Reserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupDiGetClassImageListExA(
    ClassImageListData: [*c]SP_CLASSIMAGELIST_DATA, // SP_CLASSIMAGELIST_DATA* in/out
    MachineName: [*c]const u8, // LPCSTR optional
    Reserved: ?*anyopaque // void* optional
) callconv(std.os.windows.WINAPI) i32;
proc SetupDiGetClassImageListExA(
    ClassImageListData: ptr SP_CLASSIMAGELIST_DATA,  # SP_CLASSIMAGELIST_DATA* in/out
    MachineName: cstring,  # LPCSTR optional
    Reserved: pointer  # void* optional
): int32 {.importc: "SetupDiGetClassImageListExA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetClassImageListExA(
    SP_CLASSIMAGELIST_DATA* ClassImageListData,   // SP_CLASSIMAGELIST_DATA* in/out
    const(char)* MachineName,   // LPCSTR optional
    void* Reserved   // void* optional
);
ccall((:SetupDiGetClassImageListExA, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{SP_CLASSIMAGELIST_DATA}, Cstring, Ptr{Cvoid}),
      ClassImageListData, MachineName, Reserved)
# ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> Ptr{SP_CLASSIMAGELIST_DATA}
# MachineName : LPCSTR optional -> Cstring
# Reserved : void* optional -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetClassImageListExA(
    void* ClassImageListData,
    const char* MachineName,
    void* Reserved);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
-- ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out
-- MachineName : LPCSTR optional
-- Reserved : void* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetClassImageListExA = lib.func('__stdcall', 'SetupDiGetClassImageListExA', 'int32_t', ['void *', 'str', 'void *']);
// SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
// ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> 'void *'
// MachineName : LPCSTR optional -> 'str'
// Reserved : void* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiGetClassImageListExA: { parameters: ["pointer", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved)
// ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> "pointer"
// MachineName : LPCSTR optional -> "buffer"
// Reserved : void* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiGetClassImageListExA(
    void* ClassImageListData,
    const char* MachineName,
    void* Reserved);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetClassImageListExA(ClassImageListData, MachineName, Reserved);
// ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out
// MachineName : LPCSTR optional
// Reserved : void* optional
// 構造体/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 SetupDiGetClassImageListExA(
        Pointer ClassImageListData,   // SP_CLASSIMAGELIST_DATA* in/out
        String MachineName,   // LPCSTR optional
        Pointer Reserved   // void* optional
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiGetClassImageListExA = SetupDiGetClassImageListExA(
    ClassImageListData : SP_CLASSIMAGELIST_DATA*,   # SP_CLASSIMAGELIST_DATA* in/out
    MachineName : UInt8*,   # LPCSTR optional
    Reserved : Void*   # void* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupDiGetClassImageListExANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
typedef SetupDiGetClassImageListExADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Void>);
final SetupDiGetClassImageListExA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetClassImageListExANative, SetupDiGetClassImageListExADart>('SetupDiGetClassImageListExA');
// ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> Pointer<Void>
// MachineName : LPCSTR optional -> Pointer<Utf8>
// Reserved : void* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetClassImageListExA(
  ClassImageListData: Pointer;   // SP_CLASSIMAGELIST_DATA* in/out
  MachineName: PAnsiChar;   // LPCSTR optional
  Reserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassImageListExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiGetClassImageListExA"
  c_SetupDiGetClassImageListExA :: Ptr () -> CString -> Ptr () -> IO CInt
-- ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> Ptr ()
-- MachineName : LPCSTR optional -> CString
-- Reserved : void* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdigetclassimagelistexa =
  foreign "SetupDiGetClassImageListExA"
    ((ptr void) @-> string @-> (ptr void) @-> returning int32_t)
(* ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> (ptr void) *)
(* MachineName : LPCSTR optional -> string *)
(* Reserved : void* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiGetClassImageListExA" setup-di-get-class-image-list-ex-a :convention :stdcall) :int32
  (class-image-list-data :pointer)   ; SP_CLASSIMAGELIST_DATA* in/out
  (machine-name :string)   ; LPCSTR optional
  (reserved :pointer))   ; void* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiGetClassImageListExA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetClassImageListExA(LPVOID ClassImageListData, LPCSTR MachineName, LPVOID Reserved)');
# my $ret = $SetupDiGetClassImageListExA->Call($ClassImageListData, $MachineName, $Reserved);
# ClassImageListData : SP_CLASSIMAGELIST_DATA* in/out -> LPVOID
# MachineName : LPCSTR optional -> LPCSTR
# Reserved : void* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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