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

SetupDiGetClassImageIndex

関数
指定クラスのイメージリスト内アイコン索引を取得する。
DLLSETUPAPI.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetupDiGetClassImageIndex(
    SP_CLASSIMAGELIST_DATA* ClassImageListData,
    const GUID* ClassGuid,
    INT* ImageIndex
);

パラメーター

名前方向説明
ClassImageListDataSP_CLASSIMAGELIST_DATA*inSetupDiGetClassImageListで取得済みのイメージリスト構造体。
ClassGuidGUID*inイメージインデックスを取得する対象クラスのGUID。
ImageIndexINT*outイメージリスト内の該当アイコンのインデックスを受け取るポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetupDiGetClassImageIndex = ctypes.windll.setupapi.SetupDiGetClassImageIndex
SetupDiGetClassImageIndex.restype = wintypes.BOOL
SetupDiGetClassImageIndex.argtypes = [
    ctypes.c_void_p,  # ClassImageListData : SP_CLASSIMAGELIST_DATA*
    ctypes.c_void_p,  # ClassGuid : GUID*
    ctypes.POINTER(ctypes.c_int),  # ImageIndex : INT* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetClassImageIndex = Fiddle::Function.new(
  lib['SetupDiGetClassImageIndex'],
  [
    Fiddle::TYPE_VOIDP,  # ClassImageListData : SP_CLASSIMAGELIST_DATA*
    Fiddle::TYPE_VOIDP,  # ClassGuid : GUID*
    Fiddle::TYPE_VOIDP,  # ImageIndex : INT* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetClassImageIndex(
        ClassImageListData: *mut SP_CLASSIMAGELIST_DATA,  // SP_CLASSIMAGELIST_DATA*
        ClassGuid: *const GUID,  // GUID*
        ImageIndex: *mut i32  // INT* 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 SetupDiGetClassImageIndex(IntPtr ClassImageListData, ref Guid ClassGuid, out int ImageIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetClassImageIndex' -Namespace Win32 -PassThru
# $api::SetupDiGetClassImageIndex(ClassImageListData, ClassGuid, ImageIndex)
#uselib "SETUPAPI.dll"
#func global SetupDiGetClassImageIndex "SetupDiGetClassImageIndex" sptr, sptr, sptr
; SetupDiGetClassImageIndex varptr(ClassImageListData), varptr(ClassGuid), varptr(ImageIndex)   ; 戻り値は stat
; ClassImageListData : SP_CLASSIMAGELIST_DATA* -> "sptr"
; ClassGuid : GUID* -> "sptr"
; ImageIndex : INT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassImageIndex "SetupDiGetClassImageIndex" var, var, var
; res = SetupDiGetClassImageIndex(ClassImageListData, ClassGuid, ImageIndex)
; ClassImageListData : SP_CLASSIMAGELIST_DATA* -> "var"
; ClassGuid : GUID* -> "var"
; ImageIndex : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetClassImageIndex(SP_CLASSIMAGELIST_DATA* ClassImageListData, GUID* ClassGuid, INT* ImageIndex)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetClassImageIndex "SetupDiGetClassImageIndex" var, var, var
; res = SetupDiGetClassImageIndex(ClassImageListData, ClassGuid, ImageIndex)
; ClassImageListData : SP_CLASSIMAGELIST_DATA* -> "var"
; ClassGuid : GUID* -> "var"
; ImageIndex : INT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetClassImageIndex = setupapi.NewProc("SetupDiGetClassImageIndex")
)

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

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

typedef SetupDiGetClassImageIndexNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
typedef SetupDiGetClassImageIndexDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Int32>);
final SetupDiGetClassImageIndex = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetClassImageIndexNative, SetupDiGetClassImageIndexDart>('SetupDiGetClassImageIndex');
// ClassImageListData : SP_CLASSIMAGELIST_DATA* -> Pointer<Void>
// ClassGuid : GUID* -> Pointer<Void>
// ImageIndex : INT* out -> Pointer<Int32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetClassImageIndex(
  ClassImageListData: Pointer;   // SP_CLASSIMAGELIST_DATA*
  ClassGuid: PGUID;   // GUID*
  ImageIndex: Pointer   // INT* out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetClassImageIndex';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setupdigetclassimageindex =
  foreign "SetupDiGetClassImageIndex"
    ((ptr void) @-> (ptr void) @-> (ptr int32_t) @-> returning int32_t)
(* ClassImageListData : SP_CLASSIMAGELIST_DATA* -> (ptr void) *)
(* ClassGuid : GUID* -> (ptr void) *)
(* ImageIndex : INT* 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 ("SetupDiGetClassImageIndex" setup-di-get-class-image-index :convention :stdcall) :int32
  (class-image-list-data :pointer)   ; SP_CLASSIMAGELIST_DATA*
  (class-guid :pointer)   ; GUID*
  (image-index :pointer))   ; INT* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupDiGetClassImageIndex = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetClassImageIndex(LPVOID ClassImageListData, LPVOID ClassGuid, LPVOID ImageIndex)');
# my $ret = $SetupDiGetClassImageIndex->Call($ClassImageListData, $ClassGuid, $ImageIndex);
# ClassImageListData : SP_CLASSIMAGELIST_DATA* -> LPVOID
# ClassGuid : GUID* -> LPVOID
# ImageIndex : INT* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型