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

ExtractIconExW

関数
実行ファイルから大小のアイコンを複数取り出す。
DLLSHELL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

DWORD ExtractIconExW(
    LPCWSTR lpszFile,
    INT nIconIndex,
    HICON* phiconLarge,   // optional
    HICON* phiconSmall,   // optional
    DWORD nIcons
);

パラメーター

名前方向説明
lpszFileLPCWSTRinアイコンの抽出元となる実行可能ファイル、DLL、またはアイコンファイルの名前を指定する、null で終わる文字列へのポインターです。
nIconIndexINTin

抽出する最初のアイコンの 0 から始まるインデックスを指定します。たとえば、この値が 0 の場合、関数は指定されたファイル内の最初のアイコンを抽出します。

この値が –1 で、phiconLargephiconSmall の両方が NULL の場合、関数は指定されたファイル内のアイコンの総数を返します。ファイルが実行可能ファイルまたは DLL の場合、戻り値は RT_GROUP_ICON リソースの数になります。ファイルが .ico ファイルの場合、戻り値は 1 になります。

この値が負の数で、phiconLarge または phiconSmall のいずれかが NULL でない場合、関数はリソース識別子が nIconIndex の絶対値に等しいアイコンから抽出を開始します。たとえば、リソース識別子が 3 のアイコンを抽出するには -3 を使用します。

phiconLargeHICON*outoptionalファイルから抽出された大きいアイコンへのハンドルを受け取るアイコンハンドルの配列へのポインターです。このパラメーターが NULL の場合、ファイルから大きいアイコンは抽出されません。
phiconSmallHICON*outoptionalファイルから抽出された小さいアイコンへのハンドルを受け取るアイコンハンドルの配列へのポインターです。このパラメーターが NULL の場合、ファイルから小さいアイコンは抽出されません。
nIconsDWORDinファイルから抽出するアイコンの数です。

戻り値の型: DWORD

公式ドキュメント

ExtractIconEx 関数は、指定された実行可能ファイル、DLL、またはアイコンファイルから抽出した大きいアイコンまたは小さいアイコンへのハンドルの配列を作成します。(Unicode)

戻り値

型: UINT

nIconIndex パラメーターが -1 で、phiconLargephiconSmall の両方のパラメーターが NULL の場合、戻り値は指定されたファイルに含まれるアイコンの数になります。

nIconIndex パラメーターが -1 以外の値で、phiconLarge または phiconSmall のいずれかが NULL でない場合、戻り値はファイルから正常に抽出されたアイコンの数になります。

メモ

関数がエラーを検出した場合、UINT_MAX を返します。この場合、GetLastError を呼び出してエラーコードを取得できます。たとえば、nIconIndex パラメーターが -1 以外の値で、phiconLarge または phiconSmall のいずれかが NULL でないときに、lpszFile で指定されたファイルが見つからない場合、この関数は UINT_MAX を返します。この場合、GetLastErrorERROR_FILE_NOT_FOUND (2) を返します。

解説(Remarks)

ExtractIconEx によって抽出されたすべてのアイコンが不要になったときは、DestroyIcon 関数を呼び出して破棄する必要があります。

大きいアイコンと小さいアイコンの寸法を取得するには、SM_CXICONSM_CYICONSM_CXSMICON、および SM_CYSMICON フラグとともにこの関数を使用します。

メモ

shellapi.h ヘッダーは ExtractIconEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

DWORD ExtractIconExW(
    LPCWSTR lpszFile,
    INT nIconIndex,
    HICON* phiconLarge,   // optional
    HICON* phiconSmall,   // optional
    DWORD nIcons
);
[DllImport("SHELL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint ExtractIconExW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpszFile,   // LPCWSTR
    int nIconIndex,   // INT
    IntPtr phiconLarge,   // HICON* optional, out
    IntPtr phiconSmall,   // HICON* optional, out
    uint nIcons   // DWORD
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ExtractIconExW(
    <MarshalAs(UnmanagedType.LPWStr)> lpszFile As String,   ' LPCWSTR
    nIconIndex As Integer,   ' INT
    phiconLarge As IntPtr,   ' HICON* optional, out
    phiconSmall As IntPtr,   ' HICON* optional, out
    nIcons As UInteger   ' DWORD
) As UInteger
End Function
' lpszFile : LPCWSTR
' nIconIndex : INT
' phiconLarge : HICON* optional, out
' phiconSmall : HICON* optional, out
' nIcons : DWORD
Declare PtrSafe Function ExtractIconExW Lib "shell32" ( _
    ByVal lpszFile As LongPtr, _
    ByVal nIconIndex As Long, _
    ByVal phiconLarge As LongPtr, _
    ByVal phiconSmall As LongPtr, _
    ByVal nIcons 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

ExtractIconExW = ctypes.windll.shell32.ExtractIconExW
ExtractIconExW.restype = wintypes.DWORD
ExtractIconExW.argtypes = [
    wintypes.LPCWSTR,  # lpszFile : LPCWSTR
    ctypes.c_int,  # nIconIndex : INT
    ctypes.c_void_p,  # phiconLarge : HICON* optional, out
    ctypes.c_void_p,  # phiconSmall : HICON* optional, out
    wintypes.DWORD,  # nIcons : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procExtractIconExW = shell32.NewProc("ExtractIconExW")
)

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

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

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

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

let extracticonexw =
  foreign "ExtractIconExW"
    ((ptr uint16_t) @-> int32_t @-> (ptr void) @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* lpszFile : LPCWSTR -> (ptr uint16_t) *)
(* nIconIndex : INT -> int32_t *)
(* phiconLarge : HICON* optional, out -> (ptr void) *)
(* phiconSmall : HICON* optional, out -> (ptr void) *)
(* nIcons : 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 ("ExtractIconExW" extract-icon-ex-w :convention :stdcall) :uint32
  (lpsz-file (:string :encoding :utf-16le))   ; LPCWSTR
  (n-icon-index :int32)   ; INT
  (phicon-large :pointer)   ; HICON* optional, out
  (phicon-small :pointer)   ; HICON* optional, out
  (n-icons :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExtractIconExW = Win32::API::More->new('SHELL32',
    'DWORD ExtractIconExW(LPCWSTR lpszFile, int nIconIndex, HANDLE phiconLarge, HANDLE phiconSmall, DWORD nIcons)');
# my $ret = $ExtractIconExW->Call($lpszFile, $nIconIndex, $phiconLarge, $phiconSmall, $nIcons);
# lpszFile : LPCWSTR -> LPCWSTR
# nIconIndex : INT -> int
# phiconLarge : HICON* optional, out -> HANDLE
# phiconSmall : HICON* optional, out -> HANDLE
# nIcons : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目