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

SetupDiLoadClassIcon

関数
指定したデバイスクラスのアイコンを読み込む。
DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// SETUPAPI.dll
#include <windows.h>

BOOL SetupDiLoadClassIcon(
    const GUID* ClassGuid,
    HICON* LargeIcon,   // optional
    INT* MiniIconIndex   // optional
);

パラメーター

名前方向説明
ClassGuidGUID*inアイコンを読み込む対象のセットアップクラスGUID。
LargeIconHICON*outoptionalクラスの大アイコンハンドルを受け取るポインタ。不要ならNULL。使用後はDestroyIconで破棄する。
MiniIconIndexINT*outoptionalミニアイコンのインデックスを受け取るポインタ。不要ならNULLを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// SETUPAPI.dll
#include <windows.h>

BOOL SetupDiLoadClassIcon(
    const GUID* ClassGuid,
    HICON* LargeIcon,   // optional
    INT* MiniIconIndex   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiLoadClassIcon(
    ref Guid ClassGuid,   // GUID*
    IntPtr LargeIcon,   // HICON* optional, out
    IntPtr MiniIconIndex   // INT* optional, out
);
<DllImport("SETUPAPI.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiLoadClassIcon(
    ByRef ClassGuid As Guid,   ' GUID*
    LargeIcon As IntPtr,   ' HICON* optional, out
    MiniIconIndex As IntPtr   ' INT* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ClassGuid : GUID*
' LargeIcon : HICON* optional, out
' MiniIconIndex : INT* optional, out
Declare PtrSafe Function SetupDiLoadClassIcon Lib "setupapi" ( _
    ByVal ClassGuid As LongPtr, _
    ByVal LargeIcon As LongPtr, _
    ByVal MiniIconIndex As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupDiLoadClassIcon = ctypes.windll.setupapi.SetupDiLoadClassIcon
SetupDiLoadClassIcon.restype = wintypes.BOOL
SetupDiLoadClassIcon.argtypes = [
    ctypes.c_void_p,  # ClassGuid : GUID*
    ctypes.c_void_p,  # LargeIcon : HICON* optional, out
    ctypes.POINTER(ctypes.c_int),  # MiniIconIndex : INT* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiLoadClassIcon = Fiddle::Function.new(
  lib['SetupDiLoadClassIcon'],
  [
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID*
    Fiddle::TYPE_VOIDP,  # LargeIcon : HICON* optional, out
    Fiddle::TYPE_VOIDP,  # MiniIconIndex : INT* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiLoadClassIcon(
        ClassGuid: *const GUID,  // GUID*
        LargeIcon: *mut *mut core::ffi::c_void,  // HICON* optional, out
        MiniIconIndex: *mut i32  // INT* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", SetLastError = true)]
public static extern bool SetupDiLoadClassIcon(ref Guid ClassGuid, IntPtr LargeIcon, IntPtr MiniIconIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiLoadClassIcon' -Namespace Win32 -PassThru
# $api::SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
#uselib "SETUPAPI.dll"
#func global SetupDiLoadClassIcon "SetupDiLoadClassIcon" sptr, sptr, sptr
; SetupDiLoadClassIcon varptr(ClassGuid), LargeIcon, varptr(MiniIconIndex)   ; 戻り値は stat
; ClassGuid : GUID* -> "sptr"
; LargeIcon : HICON* optional, out -> "sptr"
; MiniIconIndex : INT* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiLoadClassIcon "SetupDiLoadClassIcon" var, sptr, var
; res = SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
; ClassGuid : GUID* -> "var"
; LargeIcon : HICON* optional, out -> "sptr"
; MiniIconIndex : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiLoadClassIcon(GUID* ClassGuid, HICON* LargeIcon, INT* MiniIconIndex)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiLoadClassIcon "SetupDiLoadClassIcon" var, intptr, var
; res = SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
; ClassGuid : GUID* -> "var"
; LargeIcon : HICON* optional, out -> "intptr"
; MiniIconIndex : INT* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiLoadClassIcon = setupapi.NewProc("SetupDiLoadClassIcon")
)

// ClassGuid (GUID*), LargeIcon (HICON* optional, out), MiniIconIndex (INT* optional, out)
r1, _, err := procSetupDiLoadClassIcon.Call(
	uintptr(ClassGuid),
	uintptr(LargeIcon),
	uintptr(MiniIconIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiLoadClassIcon(
  ClassGuid: PGUID;   // GUID*
  LargeIcon: Pointer;   // HICON* optional, out
  MiniIconIndex: Pointer   // INT* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiLoadClassIcon';
result := DllCall("SETUPAPI\SetupDiLoadClassIcon"
    , "Ptr", ClassGuid   ; GUID*
    , "Ptr", LargeIcon   ; HICON* optional, out
    , "Ptr", MiniIconIndex   ; INT* optional, out
    , "Int")   ; return: BOOL
●SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex) = DLL("SETUPAPI.dll", "bool SetupDiLoadClassIcon(void*, void*, void*)")
# 呼び出し: SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
# ClassGuid : GUID* -> "void*"
# LargeIcon : HICON* optional, out -> "void*"
# MiniIconIndex : INT* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupDiLoadClassIcon(
    ClassGuid: [*c]GUID, // GUID*
    LargeIcon: ?*anyopaque, // HICON* optional, out
    MiniIconIndex: [*c]i32 // INT* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SetupDiLoadClassIcon(
    ClassGuid: ptr GUID,  # GUID*
    LargeIcon: pointer,  # HICON* optional, out
    MiniIconIndex: ptr int32  # INT* optional, out
): int32 {.importc: "SetupDiLoadClassIcon", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupDiLoadClassIcon(
    GUID* ClassGuid,   // GUID*
    void* LargeIcon,   // HICON* optional, out
    int* MiniIconIndex   // INT* optional, out
);
ccall((:SetupDiLoadClassIcon, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{GUID}, Ptr{Cvoid}, Ptr{Int32}),
      ClassGuid, LargeIcon, MiniIconIndex)
# ClassGuid : GUID* -> Ptr{GUID}
# LargeIcon : HICON* optional, out -> Ptr{Cvoid}
# MiniIconIndex : INT* optional, out -> Ptr{Int32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiLoadClassIcon(
    void* ClassGuid,
    void* LargeIcon,
    int32_t* MiniIconIndex);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
-- ClassGuid : GUID*
-- LargeIcon : HICON* optional, out
-- MiniIconIndex : INT* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiLoadClassIcon = lib.func('__stdcall', 'SetupDiLoadClassIcon', 'int32_t', ['void *', 'void *', 'int32_t *']);
// SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
// ClassGuid : GUID* -> 'void *'
// LargeIcon : HICON* optional, out -> 'void *'
// MiniIconIndex : INT* optional, out -> 'int32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiLoadClassIcon: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex)
// ClassGuid : GUID* -> "pointer"
// LargeIcon : HICON* optional, out -> "pointer"
// MiniIconIndex : INT* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupDiLoadClassIcon(
    void* ClassGuid,
    void* LargeIcon,
    int32_t* MiniIconIndex);
C, "SETUPAPI.dll");
// $ffi->SetupDiLoadClassIcon(ClassGuid, LargeIcon, MiniIconIndex);
// ClassGuid : GUID*
// LargeIcon : HICON* optional, out
// MiniIconIndex : INT* 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);
    boolean SetupDiLoadClassIcon(
        Pointer ClassGuid,   // GUID*
        Pointer LargeIcon,   // HICON* optional, out
        IntByReference MiniIconIndex   // INT* optional, out
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiLoadClassIcon = SetupDiLoadClassIcon(
    ClassGuid : GUID*,   # GUID*
    LargeIcon : Void*,   # HICON* optional, out
    MiniIconIndex : Int32*   # INT* 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 SetupDiLoadClassIconNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
typedef SetupDiLoadClassIconDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
final SetupDiLoadClassIcon = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiLoadClassIconNative, SetupDiLoadClassIconDart>('SetupDiLoadClassIcon');
// ClassGuid : GUID* -> Pointer<Void>
// LargeIcon : HICON* optional, out -> Pointer<Void>
// MiniIconIndex : INT* optional, out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiLoadClassIcon(
  ClassGuid: PGUID;   // GUID*
  LargeIcon: Pointer;   // HICON* optional, out
  MiniIconIndex: Pointer   // INT* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiLoadClassIcon';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupDiLoadClassIcon"
  c_SetupDiLoadClassIcon :: Ptr () -> Ptr () -> Ptr Int32 -> IO CInt
-- ClassGuid : GUID* -> Ptr ()
-- LargeIcon : HICON* optional, out -> Ptr ()
-- MiniIconIndex : INT* optional, out -> Ptr Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupdiloadclassicon =
  foreign "SetupDiLoadClassIcon"
    ((ptr void) @-> (ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* ClassGuid : GUID* -> (ptr void) *)
(* LargeIcon : HICON* optional, out -> (ptr void) *)
(* MiniIconIndex : INT* optional, out -> (ptr int32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupDiLoadClassIcon" setup-di-load-class-icon :convention :stdcall) :int32
  (class-guid :pointer)   ; GUID*
  (large-icon :pointer)   ; HICON* optional, out
  (mini-icon-index :pointer))   ; INT* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiLoadClassIcon = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiLoadClassIcon(LPVOID ClassGuid, HANDLE LargeIcon, LPVOID MiniIconIndex)');
# my $ret = $SetupDiLoadClassIcon->Call($ClassGuid, $LargeIcon, $MiniIconIndex);
# ClassGuid : GUID* -> LPVOID
# LargeIcon : HICON* optional, out -> HANDLE
# MiniIconIndex : INT* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。