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

SHDefExtractIconW

関数
ファイル(Unicode)から既定の方法でアイコンを抽出する。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHDefExtractIconW(
    LPCWSTR pszIconFile,
    INT iIndex,
    DWORD uFlags,
    HICON* phiconLarge,   // optional
    HICON* phiconSmall,   // optional
    DWORD nIconSize
);

パラメーター

名前方向説明
pszIconFileLPCWSTRinアイコンの抽出元となるファイルのパスと名前を含む、null で終わるバッファーへのポインター。
iIndexINTinpszIconFile で指定したファイル内のアイコンの位置。正の数の場合、ファイル内のアイコンの 0 から始まる位置を指します。たとえば、0 はリソースファイル内の 1 番目のアイコンを指し、2 は 3 番目を指します。負の数の場合は、アイコンのリソース ID を指します。
uFlagsDWORDin

アイコンの抽出を制御するフラグ。

GIL_SIMULATEDOC

抽出したアイコンを既定のドキュメントアイコンに重ねて、最終的なアイコンを作成します。このアイコンは、より適切なアイコンが見つからない、または取得できない場合に使用できます。

phiconLargeHICON*outoptionalHICON へのポインター。この関数が正常に返ると、nIconSizeLOWORD で指定された大きいバージョンのアイコンのハンドルを受け取ります。この値は NULL でもかまいません。
phiconSmallHICON*outoptionalHICON へのポインター。この関数が正常に返ると、nIconSizeHIWORD で指定された小さいバージョンのアイコンのハンドルを受け取ります。
nIconSizeDWORDin

LOWORD に大きいアイコンのサイズ、HIWORD に小さいアイコンのサイズを含む値。サイズはピクセル単位で測定されます。既定の大小のサイズを指定するには 0 を渡します。

- uFlags.GIL_SIMULATEDOC

抽出したアイコンを既定のドキュメントアイコンに重ねて、最終的なアイコンを作成します。このアイコンは、より適切なアイコンが見つからない、または取得できない場合に使用できます。

戻り値の型: HRESULT

公式ドキュメント

ファイルからアイコンを抽出するための既定のハンドラーを提供します。(Unicode)

戻り値

型: HRESULT

この関数は次のいずれかの値を返します。

戻り値 説明
S_OK
成功しました。
S_FALSE
要求されたアイコンが存在しません。
E_FAIL
ファイルにアクセスできないか、低速なリンク経由でアクセスされています。

解説(Remarks)

この関数で作成されたアイコンリソースが不要になった際に解放するのは、呼び出し元の責任です。これは DestroyIcon 関数で行えます。

メモ

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SHDefExtractIcon を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// SHELL32.dll  (Unicode / -W)
#include <windows.h>

HRESULT SHDefExtractIconW(
    LPCWSTR pszIconFile,
    INT iIndex,
    DWORD uFlags,
    HICON* phiconLarge,   // optional
    HICON* phiconSmall,   // optional
    DWORD nIconSize
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int SHDefExtractIconW(
    [MarshalAs(UnmanagedType.LPWStr)] string pszIconFile,   // LPCWSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    IntPtr phiconLarge,   // HICON* optional, out
    IntPtr phiconSmall,   // HICON* optional, out
    uint nIconSize   // DWORD
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SHDefExtractIconW(
    <MarshalAs(UnmanagedType.LPWStr)> pszIconFile As String,   ' LPCWSTR
    iIndex As Integer,   ' INT
    uFlags As UInteger,   ' DWORD
    phiconLarge As IntPtr,   ' HICON* optional, out
    phiconSmall As IntPtr,   ' HICON* optional, out
    nIconSize As UInteger   ' DWORD
) As Integer
End Function
' pszIconFile : LPCWSTR
' iIndex : INT
' uFlags : DWORD
' phiconLarge : HICON* optional, out
' phiconSmall : HICON* optional, out
' nIconSize : DWORD
Declare PtrSafe Function SHDefExtractIconW Lib "shell32" ( _
    ByVal pszIconFile As LongPtr, _
    ByVal iIndex As Long, _
    ByVal uFlags As Long, _
    ByVal phiconLarge As LongPtr, _
    ByVal phiconSmall As LongPtr, _
    ByVal nIconSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SHDefExtractIconW = ctypes.windll.shell32.SHDefExtractIconW
SHDefExtractIconW.restype = ctypes.c_int
SHDefExtractIconW.argtypes = [
    wintypes.LPCWSTR,  # pszIconFile : LPCWSTR
    ctypes.c_int,  # iIndex : INT
    wintypes.DWORD,  # uFlags : DWORD
    ctypes.c_void_p,  # phiconLarge : HICON* optional, out
    ctypes.c_void_p,  # phiconSmall : HICON* optional, out
    wintypes.DWORD,  # nIconSize : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
SHDefExtractIconW = Fiddle::Function.new(
  lib['SHDefExtractIconW'],
  [
    Fiddle::TYPE_VOIDP,  # pszIconFile : LPCWSTR
    Fiddle::TYPE_INT,  # iIndex : INT
    -Fiddle::TYPE_INT,  # uFlags : DWORD
    Fiddle::TYPE_VOIDP,  # phiconLarge : HICON* optional, out
    Fiddle::TYPE_VOIDP,  # phiconSmall : HICON* optional, out
    -Fiddle::TYPE_INT,  # nIconSize : DWORD
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shell32")]
extern "system" {
    fn SHDefExtractIconW(
        pszIconFile: *const u16,  // LPCWSTR
        iIndex: i32,  // INT
        uFlags: u32,  // DWORD
        phiconLarge: *mut *mut core::ffi::c_void,  // HICON* optional, out
        phiconSmall: *mut *mut core::ffi::c_void,  // HICON* optional, out
        nIconSize: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode)]
public static extern int SHDefExtractIconW([MarshalAs(UnmanagedType.LPWStr)] string pszIconFile, int iIndex, uint uFlags, IntPtr phiconLarge, IntPtr phiconSmall, uint nIconSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_SHDefExtractIconW' -Namespace Win32 -PassThru
# $api::SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
#uselib "SHELL32.dll"
#func global SHDefExtractIconW "SHDefExtractIconW" wptr, wptr, wptr, wptr, wptr, wptr
; SHDefExtractIconW pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize   ; 戻り値は stat
; pszIconFile : LPCWSTR -> "wptr"
; iIndex : INT -> "wptr"
; uFlags : DWORD -> "wptr"
; phiconLarge : HICON* optional, out -> "wptr"
; phiconSmall : HICON* optional, out -> "wptr"
; nIconSize : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global SHDefExtractIconW "SHDefExtractIconW" wstr, int, int, sptr, sptr, int
; res = SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
; pszIconFile : LPCWSTR -> "wstr"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; phiconLarge : HICON* optional, out -> "sptr"
; phiconSmall : HICON* optional, out -> "sptr"
; nIconSize : DWORD -> "int"
; HRESULT SHDefExtractIconW(LPCWSTR pszIconFile, INT iIndex, DWORD uFlags, HICON* phiconLarge, HICON* phiconSmall, DWORD nIconSize)
#uselib "SHELL32.dll"
#cfunc global SHDefExtractIconW "SHDefExtractIconW" wstr, int, int, intptr, intptr, int
; res = SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
; pszIconFile : LPCWSTR -> "wstr"
; iIndex : INT -> "int"
; uFlags : DWORD -> "int"
; phiconLarge : HICON* optional, out -> "intptr"
; phiconSmall : HICON* optional, out -> "intptr"
; nIconSize : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procSHDefExtractIconW = shell32.NewProc("SHDefExtractIconW")
)

// pszIconFile (LPCWSTR), iIndex (INT), uFlags (DWORD), phiconLarge (HICON* optional, out), phiconSmall (HICON* optional, out), nIconSize (DWORD)
r1, _, err := procSHDefExtractIconW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszIconFile))),
	uintptr(iIndex),
	uintptr(uFlags),
	uintptr(phiconLarge),
	uintptr(phiconSmall),
	uintptr(nIconSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SHDefExtractIconW(
  pszIconFile: PWideChar;   // LPCWSTR
  iIndex: Integer;   // INT
  uFlags: DWORD;   // DWORD
  phiconLarge: Pointer;   // HICON* optional, out
  phiconSmall: Pointer;   // HICON* optional, out
  nIconSize: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHDefExtractIconW';
result := DllCall("SHELL32\SHDefExtractIconW"
    , "WStr", pszIconFile   ; LPCWSTR
    , "Int", iIndex   ; INT
    , "UInt", uFlags   ; DWORD
    , "Ptr", phiconLarge   ; HICON* optional, out
    , "Ptr", phiconSmall   ; HICON* optional, out
    , "UInt", nIconSize   ; DWORD
    , "Int")   ; return: HRESULT
●SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize) = DLL("SHELL32.dll", "int SHDefExtractIconW(char*, int, dword, void*, void*, dword)")
# 呼び出し: SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
# pszIconFile : LPCWSTR -> "char*"
# iIndex : INT -> "int"
# uFlags : DWORD -> "dword"
# phiconLarge : HICON* optional, out -> "void*"
# phiconSmall : HICON* optional, out -> "void*"
# nIconSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shell32" fn SHDefExtractIconW(
    pszIconFile: [*c]const u16, // LPCWSTR
    iIndex: i32, // INT
    uFlags: u32, // DWORD
    phiconLarge: ?*anyopaque, // HICON* optional, out
    phiconSmall: ?*anyopaque, // HICON* optional, out
    nIconSize: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SHDefExtractIconW(
    pszIconFile: WideCString,  # LPCWSTR
    iIndex: int32,  # INT
    uFlags: uint32,  # DWORD
    phiconLarge: pointer,  # HICON* optional, out
    phiconSmall: pointer,  # HICON* optional, out
    nIconSize: uint32  # DWORD
): int32 {.importc: "SHDefExtractIconW", stdcall, dynlib: "SHELL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shell32");
extern(Windows)
int SHDefExtractIconW(
    const(wchar)* pszIconFile,   // LPCWSTR
    int iIndex,   // INT
    uint uFlags,   // DWORD
    void* phiconLarge,   // HICON* optional, out
    void* phiconSmall,   // HICON* optional, out
    uint nIconSize   // DWORD
);
ccall((:SHDefExtractIconW, "SHELL32.dll"), stdcall, Int32,
      (Cwstring, Int32, UInt32, Ptr{Cvoid}, Ptr{Cvoid}, UInt32),
      pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
# pszIconFile : LPCWSTR -> Cwstring
# iIndex : INT -> Int32
# uFlags : DWORD -> UInt32
# phiconLarge : HICON* optional, out -> Ptr{Cvoid}
# phiconSmall : HICON* optional, out -> Ptr{Cvoid}
# nIconSize : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SHDefExtractIconW(
    const uint16_t* pszIconFile,
    int32_t iIndex,
    uint32_t uFlags,
    void* phiconLarge,
    void* phiconSmall,
    uint32_t nIconSize);
]]
local shell32 = ffi.load("shell32")
-- shell32.SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
-- pszIconFile : LPCWSTR
-- iIndex : INT
-- uFlags : DWORD
-- phiconLarge : HICON* optional, out
-- phiconSmall : HICON* optional, out
-- nIconSize : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const SHDefExtractIconW = lib.func('__stdcall', 'SHDefExtractIconW', 'int32_t', ['str16', 'int32_t', 'uint32_t', 'void *', 'void *', 'uint32_t']);
// SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
// pszIconFile : LPCWSTR -> 'str16'
// iIndex : INT -> 'int32_t'
// uFlags : DWORD -> 'uint32_t'
// phiconLarge : HICON* optional, out -> 'void *'
// phiconSmall : HICON* optional, out -> 'void *'
// nIconSize : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  SHDefExtractIconW: { parameters: ["buffer", "i32", "u32", "pointer", "pointer", "u32"], result: "i32" },
});
// lib.symbols.SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize)
// pszIconFile : LPCWSTR -> "buffer"
// iIndex : INT -> "i32"
// uFlags : DWORD -> "u32"
// phiconLarge : HICON* optional, out -> "pointer"
// phiconSmall : HICON* optional, out -> "pointer"
// nIconSize : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SHDefExtractIconW(
    const uint16_t* pszIconFile,
    int32_t iIndex,
    uint32_t uFlags,
    void* phiconLarge,
    void* phiconSmall,
    uint32_t nIconSize);
C, "SHELL32.dll");
// $ffi->SHDefExtractIconW(pszIconFile, iIndex, uFlags, phiconLarge, phiconSmall, nIconSize);
// pszIconFile : LPCWSTR
// iIndex : INT
// uFlags : DWORD
// phiconLarge : HICON* optional, out
// phiconSmall : HICON* optional, out
// nIconSize : DWORD
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int SHDefExtractIconW(
        WString pszIconFile,   // LPCWSTR
        int iIndex,   // INT
        int uFlags,   // DWORD
        Pointer phiconLarge,   // HICON* optional, out
        Pointer phiconSmall,   // HICON* optional, out
        int nIconSize   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shell32")]
lib LibSHELL32
  fun SHDefExtractIconW = SHDefExtractIconW(
    pszIconFile : UInt16*,   # LPCWSTR
    iIndex : Int32,   # INT
    uFlags : UInt32,   # DWORD
    phiconLarge : Void*,   # HICON* optional, out
    phiconSmall : Void*,   # HICON* optional, out
    nIconSize : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SHDefExtractIconWNative = Int32 Function(Pointer<Utf16>, Int32, Uint32, Pointer<Void>, Pointer<Void>, Uint32);
typedef SHDefExtractIconWDart = int Function(Pointer<Utf16>, int, int, Pointer<Void>, Pointer<Void>, int);
final SHDefExtractIconW = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<SHDefExtractIconWNative, SHDefExtractIconWDart>('SHDefExtractIconW');
// pszIconFile : LPCWSTR -> Pointer<Utf16>
// iIndex : INT -> Int32
// uFlags : DWORD -> Uint32
// phiconLarge : HICON* optional, out -> Pointer<Void>
// phiconSmall : HICON* optional, out -> Pointer<Void>
// nIconSize : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SHDefExtractIconW(
  pszIconFile: PWideChar;   // LPCWSTR
  iIndex: Integer;   // INT
  uFlags: DWORD;   // DWORD
  phiconLarge: Pointer;   // HICON* optional, out
  phiconSmall: Pointer;   // HICON* optional, out
  nIconSize: DWORD   // DWORD
): Integer; stdcall;
  external 'SHELL32.dll' name 'SHDefExtractIconW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SHDefExtractIconW"
  c_SHDefExtractIconW :: CWString -> Int32 -> Word32 -> Ptr () -> Ptr () -> Word32 -> IO Int32
-- pszIconFile : LPCWSTR -> CWString
-- iIndex : INT -> Int32
-- uFlags : DWORD -> Word32
-- phiconLarge : HICON* optional, out -> Ptr ()
-- phiconSmall : HICON* optional, out -> Ptr ()
-- nIconSize : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let shdefextracticonw =
  foreign "SHDefExtractIconW"
    ((ptr uint16_t) @-> int32_t @-> uint32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning int32_t)
(* pszIconFile : LPCWSTR -> (ptr uint16_t) *)
(* iIndex : INT -> int32_t *)
(* uFlags : DWORD -> uint32_t *)
(* phiconLarge : HICON* optional, out -> (ptr void) *)
(* phiconSmall : HICON* optional, out -> (ptr void) *)
(* nIconSize : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shell32 (t "SHELL32.dll"))
(cffi:use-foreign-library shell32)

(cffi:defcfun ("SHDefExtractIconW" shdef-extract-icon-w :convention :stdcall) :int32
  (psz-icon-file (:string :encoding :utf-16le))   ; LPCWSTR
  (i-index :int32)   ; INT
  (u-flags :uint32)   ; DWORD
  (phicon-large :pointer)   ; HICON* optional, out
  (phicon-small :pointer)   ; HICON* optional, out
  (n-icon-size :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SHDefExtractIconW = Win32::API::More->new('SHELL32',
    'int SHDefExtractIconW(LPCWSTR pszIconFile, int iIndex, DWORD uFlags, HANDLE phiconLarge, HANDLE phiconSmall, DWORD nIconSize)');
# my $ret = $SHDefExtractIconW->Call($pszIconFile, $iIndex, $uFlags, $phiconLarge, $phiconSmall, $nIconSize);
# pszIconFile : LPCWSTR -> LPCWSTR
# iIndex : INT -> int
# uFlags : DWORD -> DWORD
# phiconLarge : HICON* optional, out -> HANDLE
# phiconSmall : HICON* optional, out -> HANDLE
# nIconSize : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い