ホーム › UI.Shell › ExtractAssociatedIconExA

ExtractAssociatedIconExA

関数

ファイルに関連付けられたアイコンを索引付きで取得する。

DLLSHELL32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HICON ExtractAssociatedIconExA(
    HINSTANCE hInst,   // optional
    LPSTR pszIconPath,
    WORD* piIconIndex,
    WORD* piIconId
);

パラメーター

名前	型	方向	説明
hInst	HINSTANCE	optional	アイコンを抽出するモジュールのハンドルです。
pszIconPath	LPSTR	inout	呼び出し時に、アイコンを含むファイルのフルパスとファイル名を指定する文字列へのポインターです。この関数は、そのファイルから、または当該ファイルに関連付けられた実行可能ファイルからアイコンハンドルを抽出します。この関数が戻るとき、アイコンハンドルが実行可能ファイル(このパラメーターが直接指す実行可能ファイル、または関連付けられた実行可能ファイル)から取得された場合、関数はその実行可能ファイルのフルパスとファイル名を、このパラメーターが指すバッファーに格納します。
piIconIndex	WORD*	inout	呼び出し時に、ハンドルを取得するアイコンのインデックスを指定する WORD 値へのポインターです。この関数が戻るとき、アイコンハンドルが実行可能ファイル(lpIconPath が指す実行可能ファイル、または関連付けられた実行可能ファイル)から取得された場合、この値はそのファイル内のアイコンのインデックスを指します。
piIconId	WORD*	inout	呼び出し時に、ハンドルを取得するアイコンの ID を指定する WORD 値へのポインターです。この関数が戻るとき、アイコンハンドルが実行可能ファイル(lpIconPath が指す実行可能ファイル、または関連付けられた実行可能ファイル)から取得された場合、この値はそのファイル内のアイコンの ID を指します。

戻り値の型: HICON

公式ドキュメント

ExtractAssociatedIconEx は変更される場合や利用できない場合があります。(ANSI)

戻り値

型: HICON

成功した場合はアイコンのハンドルを返します。それ以外の場合は NULL を返します。

解説(Remarks)

この関数が返すアイコンハンドルは、不要になった時点で DestroyIcon を呼び出して解放する必要があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 ExtractAssociatedIconExA(
    HINSTANCE hInst,   // optional
    LPSTR pszIconPath,
    WORD* piIconIndex,
    WORD* piIconId
);

[DllImport("SHELL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr ExtractAssociatedIconExA(
    IntPtr hInst,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszIconPath,   // LPSTR in/out
    ref ushort piIconIndex,   // WORD* in/out
    ref ushort piIconId   // WORD* in/out
);

<DllImport("SHELL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ExtractAssociatedIconExA(
    hInst As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> pszIconPath As System.Text.StringBuilder,   ' LPSTR in/out
    ByRef piIconIndex As UShort,   ' WORD* in/out
    ByRef piIconId As UShort   ' WORD* in/out
) As IntPtr
End Function

' hInst : HINSTANCE optional
' pszIconPath : LPSTR in/out
' piIconIndex : WORD* in/out
' piIconId : WORD* in/out
Declare PtrSafe Function ExtractAssociatedIconExA Lib "shell32" ( _
    ByVal hInst As LongPtr, _
    ByVal pszIconPath As String, _
    ByRef piIconIndex As Integer, _
    ByRef piIconId As Integer) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ExtractAssociatedIconExA = ctypes.windll.shell32.ExtractAssociatedIconExA
ExtractAssociatedIconExA.restype = ctypes.c_void_p
ExtractAssociatedIconExA.argtypes = [
    wintypes.HANDLE,  # hInst : HINSTANCE optional
    wintypes.LPSTR,  # pszIconPath : LPSTR in/out
    ctypes.POINTER(ctypes.c_ushort),  # piIconIndex : WORD* in/out
    ctypes.POINTER(ctypes.c_ushort),  # piIconId : WORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHELL32.dll')
ExtractAssociatedIconExA = Fiddle::Function.new(
  lib['ExtractAssociatedIconExA'],
  [
    Fiddle::TYPE_VOIDP,  # hInst : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # pszIconPath : LPSTR in/out
    Fiddle::TYPE_VOIDP,  # piIconIndex : WORD* in/out
    Fiddle::TYPE_VOIDP,  # piIconId : WORD* in/out
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "shell32")]
extern "system" {
    fn ExtractAssociatedIconExA(
        hInst: *mut core::ffi::c_void,  // HINSTANCE optional
        pszIconPath: *mut u8,  // LPSTR in/out
        piIconIndex: *mut u16,  // WORD* in/out
        piIconId: *mut u16  // WORD* in/out
    ) -> *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 ExtractAssociatedIconExA(IntPtr hInst, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszIconPath, ref ushort piIconIndex, ref ushort piIconId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ExtractAssociatedIconExA' -Namespace Win32 -PassThru
# $api::ExtractAssociatedIconExA(hInst, pszIconPath, piIconIndex, piIconId)

#uselib "SHELL32.dll"
#func global ExtractAssociatedIconExA "ExtractAssociatedIconExA" sptr, sptr, sptr, sptr
; ExtractAssociatedIconExA hInst, varptr(pszIconPath), varptr(piIconIndex), varptr(piIconId)   ; 戻り値は stat
; hInst : HINSTANCE optional -> "sptr"
; pszIconPath : LPSTR in/out -> "sptr"
; piIconIndex : WORD* in/out -> "sptr"
; piIconId : WORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SHELL32.dll"
#cfunc global ExtractAssociatedIconExA "ExtractAssociatedIconExA" sptr, var, var, var
; res = ExtractAssociatedIconExA(hInst, pszIconPath, piIconIndex, piIconId)
; hInst : HINSTANCE optional -> "sptr"
; pszIconPath : LPSTR in/out -> "var"
; piIconIndex : WORD* in/out -> "var"
; piIconId : WORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHELL32.dll"
#cfunc global ExtractAssociatedIconExA "ExtractAssociatedIconExA" sptr, sptr, sptr, sptr
; res = ExtractAssociatedIconExA(hInst, varptr(pszIconPath), varptr(piIconIndex), varptr(piIconId))
; hInst : HINSTANCE optional -> "sptr"
; pszIconPath : LPSTR in/out -> "sptr"
; piIconIndex : WORD* in/out -> "sptr"
; piIconId : WORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。