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

ExtractIconA

関数
実行ファイルから指定インデックスのアイコンを取り出す。
DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HICON ExtractIconA(
    HINSTANCE hInst,   // optional
    LPCSTR pszExeFileName,
    DWORD nIconIndex
);

パラメーター

名前方向説明
hInstHINSTANCEoptionalこの関数を呼び出すアプリケーションのインスタンスへのハンドルです。
pszExeFileNameLPCSTRin実行可能ファイル、DLL、またはアイコンファイルの名前を指定する、null で終わる文字列へのポインターです。
nIconIndexDWORDin

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

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

この値が -1 以外の負の数の場合、関数は指定されたファイル内で、リソース識別子が nIconIndex の絶対値と等しいアイコンへのハンドルを返します。たとえば、リソース識別子が 3 のアイコンを抽出するには –3 を使用します。リソース識別子が 1 のアイコンを抽出するには、ExtractIconEx 関数を使用してください。

戻り値の型: HICON

公式ドキュメント

指定された実行可能ファイル、DLL、またはアイコンファイルからアイコンのハンドルを取得します。大きいアイコンまたは小さいアイコンのハンドルの配列を取得するには、ExtractIconEx 関数を使用します。(ANSI)

戻り値

型: HICON

戻り値はアイコンへのハンドルです。指定されたファイルが実行可能ファイル、DLL、またはアイコンファイルでなかった場合、戻り値は 1 です。ファイル内にアイコンが見つからなかった場合、戻り値は NULL です。

解説(Remarks)

ExtractIcon が返したアイコンハンドルが不要になったら、DestroyIcon 関数を呼び出して破棄する必要があります。

メモ

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

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

各言語での呼び出し定義

// SHELL32.dll  (ANSI / -A)
#include <windows.h>

HICON ExtractIconA(
    HINSTANCE hInst,   // optional
    LPCSTR pszExeFileName,
    DWORD nIconIndex
);
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr ExtractIconA(
    IntPtr hInst,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string pszExeFileName,   // LPCSTR
    uint nIconIndex   // DWORD
);
<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ExtractIconA(
    hInst As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> pszExeFileName As String,   ' LPCSTR
    nIconIndex As UInteger   ' DWORD
) As IntPtr
End Function
' hInst : HINSTANCE optional
' pszExeFileName : LPCSTR
' nIconIndex : DWORD
Declare PtrSafe Function ExtractIconA Lib "shell32" ( _
    ByVal hInst As LongPtr, _
    ByVal pszExeFileName As String, _
    ByVal nIconIndex As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ExtractIconA = ctypes.windll.shell32.ExtractIconA
ExtractIconA.restype = ctypes.c_void_p
ExtractIconA.argtypes = [
    wintypes.HANDLE,  # hInst : HINSTANCE optional
    wintypes.LPCSTR,  # pszExeFileName : LPCSTR
    wintypes.DWORD,  # nIconIndex : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ExtractIconA = Fiddle::Function.new(
  lib['ExtractIconA'],
  [
    Fiddle::TYPE_VOIDP,  # hInst : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # pszExeFileName : LPCSTR
    -Fiddle::TYPE_INT,  # nIconIndex : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "shell32")]
extern "system" {
    fn ExtractIconA(
        hInst: *mut core::ffi::c_void,  // HINSTANCE optional
        pszExeFileName: *const u8,  // LPCSTR
        nIconIndex: u32  // DWORD
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHELL32.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr ExtractIconA(IntPtr hInst, [MarshalAs(UnmanagedType.LPStr)] string pszExeFileName, uint nIconIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ExtractIconA' -Namespace Win32 -PassThru
# $api::ExtractIconA(hInst, pszExeFileName, nIconIndex)
#uselib "SHELL32.dll"
#func global ExtractIconA "ExtractIconA" sptr, sptr, sptr
; ExtractIconA hInst, pszExeFileName, nIconIndex   ; 戻り値は stat
; hInst : HINSTANCE optional -> "sptr"
; pszExeFileName : LPCSTR -> "sptr"
; nIconIndex : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "SHELL32.dll"
#cfunc global ExtractIconA "ExtractIconA" sptr, str, int
; res = ExtractIconA(hInst, pszExeFileName, nIconIndex)
; hInst : HINSTANCE optional -> "sptr"
; pszExeFileName : LPCSTR -> "str"
; nIconIndex : DWORD -> "int"
; HICON ExtractIconA(HINSTANCE hInst, LPCSTR pszExeFileName, DWORD nIconIndex)
#uselib "SHELL32.dll"
#cfunc global ExtractIconA "ExtractIconA" intptr, str, int
; res = ExtractIconA(hInst, pszExeFileName, nIconIndex)
; hInst : HINSTANCE optional -> "intptr"
; pszExeFileName : LPCSTR -> "str"
; nIconIndex : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shell32 = windows.NewLazySystemDLL("SHELL32.dll")
	procExtractIconA = shell32.NewProc("ExtractIconA")
)

// hInst (HINSTANCE optional), pszExeFileName (LPCSTR), nIconIndex (DWORD)
r1, _, err := procExtractIconA.Call(
	uintptr(hInst),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszExeFileName))),
	uintptr(nIconIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HICON
function ExtractIconA(
  hInst: THandle;   // HINSTANCE optional
  pszExeFileName: PAnsiChar;   // LPCSTR
  nIconIndex: DWORD   // DWORD
): THandle; stdcall;
  external 'SHELL32.dll' name 'ExtractIconA';
result := DllCall("SHELL32\ExtractIconA"
    , "Ptr", hInst   ; HINSTANCE optional
    , "AStr", pszExeFileName   ; LPCSTR
    , "UInt", nIconIndex   ; DWORD
    , "Ptr")   ; return: HICON
●ExtractIconA(hInst, pszExeFileName, nIconIndex) = DLL("SHELL32.dll", "void* ExtractIconA(void*, char*, dword)")
# 呼び出し: ExtractIconA(hInst, pszExeFileName, nIconIndex)
# hInst : HINSTANCE optional -> "void*"
# pszExeFileName : LPCSTR -> "char*"
# nIconIndex : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shell32" fn ExtractIconA(
    hInst: ?*anyopaque, // HINSTANCE optional
    pszExeFileName: [*c]const u8, // LPCSTR
    nIconIndex: u32 // DWORD
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc ExtractIconA(
    hInst: pointer,  # HINSTANCE optional
    pszExeFileName: cstring,  # LPCSTR
    nIconIndex: uint32  # DWORD
): pointer {.importc: "ExtractIconA", stdcall, dynlib: "SHELL32.dll".}
pragma(lib, "shell32");
extern(Windows)
void* ExtractIconA(
    void* hInst,   // HINSTANCE optional
    const(char)* pszExeFileName,   // LPCSTR
    uint nIconIndex   // DWORD
);
ccall((:ExtractIconA, "SHELL32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring, UInt32),
      hInst, pszExeFileName, nIconIndex)
# hInst : HINSTANCE optional -> Ptr{Cvoid}
# pszExeFileName : LPCSTR -> Cstring
# nIconIndex : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* ExtractIconA(
    void* hInst,
    const char* pszExeFileName,
    uint32_t nIconIndex);
]]
local shell32 = ffi.load("shell32")
-- shell32.ExtractIconA(hInst, pszExeFileName, nIconIndex)
-- hInst : HINSTANCE optional
-- pszExeFileName : LPCSTR
-- nIconIndex : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHELL32.dll');
const ExtractIconA = lib.func('__stdcall', 'ExtractIconA', 'void *', ['void *', 'str', 'uint32_t']);
// ExtractIconA(hInst, pszExeFileName, nIconIndex)
// hInst : HINSTANCE optional -> 'void *'
// pszExeFileName : LPCSTR -> 'str'
// nIconIndex : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHELL32.dll", {
  ExtractIconA: { parameters: ["pointer", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.ExtractIconA(hInst, pszExeFileName, nIconIndex)
// hInst : HINSTANCE optional -> "pointer"
// pszExeFileName : LPCSTR -> "buffer"
// nIconIndex : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* ExtractIconA(
    void* hInst,
    const char* pszExeFileName,
    uint32_t nIconIndex);
C, "SHELL32.dll");
// $ffi->ExtractIconA(hInst, pszExeFileName, nIconIndex);
// hInst : HINSTANCE optional
// pszExeFileName : LPCSTR
// nIconIndex : 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.ASCII_OPTIONS);
    Pointer ExtractIconA(
        Pointer hInst,   // HINSTANCE optional
        String pszExeFileName,   // LPCSTR
        int nIconIndex   // DWORD
    );
}
@[Link("shell32")]
lib LibSHELL32
  fun ExtractIconA = ExtractIconA(
    hInst : Void*,   # HINSTANCE optional
    pszExeFileName : UInt8*,   # LPCSTR
    nIconIndex : UInt32   # DWORD
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ExtractIconANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>, Uint32);
typedef ExtractIconADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>, int);
final ExtractIconA = DynamicLibrary.open('SHELL32.dll')
    .lookupFunction<ExtractIconANative, ExtractIconADart>('ExtractIconA');
// hInst : HINSTANCE optional -> Pointer<Void>
// pszExeFileName : LPCSTR -> Pointer<Utf8>
// nIconIndex : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ExtractIconA(
  hInst: THandle;   // HINSTANCE optional
  pszExeFileName: PAnsiChar;   // LPCSTR
  nIconIndex: DWORD   // DWORD
): THandle; stdcall;
  external 'SHELL32.dll' name 'ExtractIconA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ExtractIconA"
  c_ExtractIconA :: Ptr () -> CString -> Word32 -> IO (Ptr ())
-- hInst : HINSTANCE optional -> Ptr ()
-- pszExeFileName : LPCSTR -> CString
-- nIconIndex : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let extracticona =
  foreign "ExtractIconA"
    ((ptr void) @-> string @-> uint32_t @-> returning (ptr void))
(* hInst : HINSTANCE optional -> (ptr void) *)
(* pszExeFileName : LPCSTR -> string *)
(* nIconIndex : 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 ("ExtractIconA" extract-icon-a :convention :stdcall) :pointer
  (h-inst :pointer)   ; HINSTANCE optional
  (psz-exe-file-name :string)   ; LPCSTR
  (n-icon-index :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ExtractIconA = Win32::API::More->new('SHELL32',
    'HANDLE ExtractIconA(HANDLE hInst, LPCSTR pszExeFileName, DWORD nIconIndex)');
# my $ret = $ExtractIconA->Call($hInst, $pszExeFileName, $nIconIndex);
# hInst : HINSTANCE optional -> HANDLE
# pszExeFileName : LPCSTR -> LPCSTR
# nIconIndex : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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