Win32 API 日本語リファレンス
ホーム › UI.Shell › SHGetStockIconInfo

SHGetStockIconInfo

関数
システム標準アイコンのハンドルや場所情報を取得する。
DLLSHELL32.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT SHGetStockIconInfo(
    SHSTOCKICONID siid,
    SHGSI_FLAGS uFlags,
    SHSTOCKICONINFO* psii
);

パラメーター

名前型方向説明
siidSHSTOCKICONIDin取得するアイコンを指定する SHSTOCKICONID 列挙型の値のいずれか。
uFlagsSHGSI_FLAGSin

要求する情報を指定する、次のフラグの 0 個以上の組み合わせ。

SHGSI_ICONLOCATION

SHSTOCKICONINFO 構造体の szPath メンバーと iIcon メンバーが、要求されたアイコンのパスとアイコンインデックスを、ExtractIcon 関数に渡すのに適した形式で受け取ります。このフラグの数値は 0 であるため、他のフラグに関係なく常にアイコンの位置情報を取得できます。

SHGSI_ICON

SHSTOCKICONINFO 構造体の hIcon メンバーが、指定されたアイコンのハンドルを受け取ります。

SHGSI_SYSICONINDEX

SHSTOCKICONINFO 構造体の iSysImageImage メンバーが、システムイメージリスト内における指定されたアイコンのインデックスを受け取ります。

SHGSI_LINKOVERLAY

SHGSI_ICON の値を修飾し、ファイルのアイコンにリンクオーバーレイを追加させます。

SHGSI_SELECTED

SHGSI_ICON の値を修飾し、アイコンをシステムの強調表示色とブレンドさせます。

SHGSI_LARGEICON

SHGSI_ICON の値を修飾し、SM_CXICON および SM_CYICON システムメトリックで指定されたサイズの大きい方のアイコンを取得させます。

SHGSI_SMALLICON

SHGSI_ICON の値を修飾し、SM_CXSMICON および SM_CYSMICON システムメトリックで指定されたサイズの小さい方のアイコンを取得させます。

SHGSI_SHELLICONSIZE

SHGSI_LARGEICON または SHGSI_SMALLICON の値を修飾し、システムメトリックで指定されたサイズではなく、シェルサイズのアイコンを取得させます。

psiiSHSTOCKICONINFO*inoutSHSTOCKICONINFO 構造体へのポインター。この関数を呼び出す際には、この構造体の cbSize メンバーに SHSTOCKICONINFO 構造体のサイズを設定しておく必要があります。この関数が返るときには、要求された情報を含む SHSTOCKICONINFO 構造体へのポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

システム定義のシェルアイコンに関する情報を取得します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

この関数が psii が指す SHSTOCKICONINFO 構造体の hIcon メンバーにアイコンハンドルを返す場合、不要になった時点で DestroyIcon を使用してそのアイコンを解放する責任があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT SHGetStockIconInfo(
    SHSTOCKICONID siid,
    SHGSI_FLAGS uFlags,
    SHSTOCKICONINFO* psii
);
[DllImport("SHELL32.dll", ExactSpelling = true)]
static extern int SHGetStockIconInfo(
    int siid,   // SHSTOCKICONID
    uint uFlags,   // SHGSI_FLAGS
    IntPtr psii   // SHSTOCKICONINFO* in/out
);
<DllImport("SHELL32.dll", ExactSpelling:=True)>
Public Shared Function SHGetStockIconInfo(
    siid As Integer,   ' SHSTOCKICONID
    uFlags As UInteger,   ' SHGSI_FLAGS
    psii As IntPtr   ' SHSTOCKICONINFO* in/out
) As Integer
End Function
' siid : SHSTOCKICONID
' uFlags : SHGSI_FLAGS
' psii : SHSTOCKICONINFO* in/out
Declare PtrSafe Function SHGetStockIconInfo Lib "shell32" ( _
    ByVal siid As Long, _
    ByVal uFlags As Long, _
    ByVal psii As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHGetStockIconInfo = ctypes.windll.shell32.SHGetStockIconInfo
SHGetStockIconInfo.restype = ctypes.c_int
SHGetStockIconInfo.argtypes = [
    ctypes.c_int,  # siid : SHSTOCKICONID
    wintypes.DWORD,  # uFlags : SHGSI_FLAGS
    ctypes.c_void_p,  # psii : SHSTOCKICONINFO* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHGetStockIconInfo = Fiddle::Function.new(
  lib['SHGetStockIconInfo'],
  [
    Fiddle::TYPE_INT,  # siid : SHSTOCKICONID
    -Fiddle::TYPE_INT,  # uFlags : SHGSI_FLAGS
    Fiddle::TYPE_VOIDP,  # psii : SHSTOCKICONINFO* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "shell32")]
extern "system" {
    fn SHGetStockIconInfo(
        siid: i32,  // SHSTOCKICONID
        uFlags: u32,  // SHGSI_FLAGS
        psii: *mut SHSTOCKICONINFO  // SHSTOCKICONINFO* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll")]
public static extern int SHGetStockIconInfo(int siid, uint uFlags, IntPtr psii);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHGetStockIconInfo' -Namespace Win32 -PassThru
# $api::SHGetStockIconInfo(siid, uFlags, psii)
#uselib "SHELL32.dll"
#func global SHGetStockIconInfo "SHGetStockIconInfo" sptr, sptr, sptr
; SHGetStockIconInfo siid, uFlags, varptr(psii)   ; 戻り値は stat
; siid : SHSTOCKICONID -> "sptr"
; uFlags : SHGSI_FLAGS -> "sptr"
; psii : SHSTOCKICONINFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "SHELL32.dll"
#cfunc global SHGetStockIconInfo "SHGetStockIconInfo" int, int, var
; res = SHGetStockIconInfo(siid, uFlags, psii)
; siid : SHSTOCKICONID -> "int"
; uFlags : SHGSI_FLAGS -> "int"
; psii : SHSTOCKICONINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; HRESULT SHGetStockIconInfo(SHSTOCKICONID siid, SHGSI_FLAGS uFlags, SHSTOCKICONINFO* psii)
#uselib "SHELL32.dll"
#cfunc global SHGetStockIconInfo "SHGetStockIconInfo" int, int, var
; res = SHGetStockIconInfo(siid, uFlags, psii)
; siid : SHSTOCKICONID -> "int"
; uFlags : SHGSI_FLAGS -> "int"
; psii : SHSTOCKICONINFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHGetStockIconInfo = shell32.NewProc("SHGetStockIconInfo")
)

// siid (SHSTOCKICONID), uFlags (SHGSI_FLAGS), psii (SHSTOCKICONINFO* in/out)
r1, _, err := procSHGetStockIconInfo.Call(
	uintptr(siid),
	uintptr(uFlags),
	uintptr(psii),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHGetStockIconInfo(
  siid: Integer;   // SHSTOCKICONID
  uFlags: DWORD;   // SHGSI_FLAGS
  psii: Pointer   // SHSTOCKICONINFO* in/out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetStockIconInfo';
result := DllCall("SHELL32\SHGetStockIconInfo"
    , "Int", siid   ; SHSTOCKICONID
    , "UInt", uFlags   ; SHGSI_FLAGS
    , "Ptr", psii   ; SHSTOCKICONINFO* in/out
    , "Int")   ; return: HRESULT
●SHGetStockIconInfo(siid, uFlags, psii) = DLL("SHELL32.dll", "int SHGetStockIconInfo(int, dword, void*)")
# 呼び出し: SHGetStockIconInfo(siid, uFlags, psii)
# siid : SHSTOCKICONID -> "int"
# uFlags : SHGSI_FLAGS -> "dword"
# psii : SHSTOCKICONINFO* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SHGetStockIconInfoNative = Int32 Function(Int32, Uint32, Pointer<Void>);
typedef SHGetStockIconInfoDart = int Function(int, int, Pointer<Void>);
final SHGetStockIconInfo = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHGetStockIconInfoNative, SHGetStockIconInfoDart>('SHGetStockIconInfo');
// siid : SHSTOCKICONID -> Int32
// uFlags : SHGSI_FLAGS -> Uint32
// psii : SHSTOCKICONINFO* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHGetStockIconInfo(
  siid: Integer;   // SHSTOCKICONID
  uFlags: DWORD;   // SHGSI_FLAGS
  psii: Pointer   // SHSTOCKICONINFO* in/out
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHGetStockIconInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHGetStockIconInfo"
  c_SHGetStockIconInfo :: Int32 -> Word32 -> Ptr () -> IO Int32
-- siid : SHSTOCKICONID -> Int32
-- uFlags : SHGSI_FLAGS -> Word32
-- psii : SHSTOCKICONINFO* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shgetstockiconinfo =
  foreign "SHGetStockIconInfo"
    (int32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* siid : SHSTOCKICONID -> int32_t *)
(* uFlags : SHGSI_FLAGS -> uint32_t *)
(* psii : SHSTOCKICONINFO* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHGetStockIconInfo" shget-stock-icon-info :convention :stdcall) :int32
  (siid :int32)   ; SHSTOCKICONID
  (u-flags :uint32)   ; SHGSI_FLAGS
  (psii :pointer))   ; SHSTOCKICONINFO* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHGetStockIconInfo = Win32::API::More->new('SHELL32',
    'int SHGetStockIconInfo(int siid, DWORD uFlags, LPVOID psii)');
# my $ret = $SHGetStockIconInfo->Call($siid, $uFlags, $psii);
# siid : SHSTOCKICONID -> int
# uFlags : SHGSI_FLAGS -> DWORD
# psii : SHSTOCKICONINFO* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型