ホーム › UI.Shell › ExtractAssociatedIconA

ExtractAssociatedIconA

関数

ファイルに関連付けられたアイコンのハンドルを取得する。

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

シグネチャ

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

HICON ExtractAssociatedIconA(
    HINSTANCE hInst,   // optional
    LPSTR pszIconPath,
    WORD* piIcon
);

パラメーター

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

名前

型

方向

説明

hInst

HINSTANCE

optional

呼び出し元アプリケーションのインスタンスへのハンドルです。

pszIconPath

LPSTR

inout

入力時に、アイコンを含むファイルのフルパスとファイル名を指定する文字列へのポインターです。この関数は、そのファイルから、またはそのファイルに関連付けられた実行可能ファイルからアイコンハンドルを抽出します。

この関数が戻るとき、アイコンハンドルが実行可能ファイル(lpIconPath が指す実行可能ファイル、または関連付けられた実行可能ファイル)から取得された場合、この関数はそのパラメーターが指すバッファーに、その実行可能ファイルのフルパスとファイル名を格納します。

piIcon

WORD*

inout

入力時に、ハンドルを取得するアイコンのインデックスを指定する WORD 値へのポインターです。

この関数が戻るとき、アイコンハンドルが実行可能ファイル(lpIconPath が指す実行可能ファイル、または関連付けられた実行可能ファイル)から取得された場合、この値はそのファイル内のアイコンのインデックスを指します。

戻り値の型: HICON

公式ドキュメント

ファイル内にリソースとして格納されているアイコン、またはファイルに関連付けられた実行可能ファイル内に格納されているアイコンへのハンドルを取得します。(ANSI)

戻り値

型: HICON

関数が成功した場合、戻り値はアイコンハンドルです。アイコンが関連付けられた実行可能ファイルから抽出された場合、この関数は lpIconPath が指す文字列にその実行可能ファイルのフルパスとファイル名を格納し、lpiIcon が指す WORD にアイコンの識別子を格納します。

関数が失敗した場合、戻り値は NULL です。

解説(Remarks)

ExtractAssociatedIcon が返すアイコンハンドルが不要になったら、呼び出し元は DestroyIcon 関数を呼び出してそのハンドルを解放する責任があります。

ExtractAssociatedIcon 関数は、まず lpIconPath で指定されたファイル内でインデックス付きアイコンを探します。そのファイルからアイコンハンドルを取得できず、かつそのファイルに関連付けられた実行可能ファイルがある場合は、その実行可能ファイル内でアイコンを探します。実行可能ファイルとの関連付けはファイル名拡張子に基づいており、レジストリのユーザーごとの部分に格納されています。

メモ

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

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

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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