ホーム › UI.Shell › ExtractAssociatedIconExW

ExtractAssociatedIconExW

関数

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

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

シグネチャ

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

HICON ExtractAssociatedIconExW(
    HINSTANCE hInst,   // optional
    LPWSTR pszIconPath,
    WORD* piIconIndex,
    WORD* piIconId
);

パラメーター

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

戻り値の型: HICON

公式ドキュメント

ExtractAssociatedIconEx は変更または利用不可となる場合があります。(Unicode)

戻り値

型: HICON

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

解説(Remarks)

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

メモ

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして ExtractAssociatedIconEx を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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>

HICON ExtractAssociatedIconExW(
    HINSTANCE hInst,   // optional
    LPWSTR pszIconPath,
    WORD* piIconIndex,
    WORD* piIconId
);

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

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

' hInst : HINSTANCE optional
' pszIconPath : LPWSTR in/out
' piIconIndex : WORD* in/out
' piIconId : WORD* in/out
Declare PtrSafe Function ExtractAssociatedIconExW Lib "shell32" ( _
    ByVal hInst As LongPtr, _
    ByVal pszIconPath As LongPtr, _
    ByRef piIconIndex As Integer, _
    ByRef piIconId As Integer) As LongPtr
' 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

ExtractAssociatedIconExW = ctypes.windll.shell32.ExtractAssociatedIconExW
ExtractAssociatedIconExW.restype = ctypes.c_void_p
ExtractAssociatedIconExW.argtypes = [
    wintypes.HANDLE,  # hInst : HINSTANCE optional
    wintypes.LPWSTR,  # pszIconPath : LPWSTR 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')
ExtractAssociatedIconExW = Fiddle::Function.new(
  lib['ExtractAssociatedIconExW'],
  [
    Fiddle::TYPE_VOIDP,  # hInst : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # pszIconPath : LPWSTR in/out
    Fiddle::TYPE_VOIDP,  # piIconIndex : WORD* in/out
    Fiddle::TYPE_VOIDP,  # piIconId : WORD* in/out
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "shell32")]
extern "system" {
    fn ExtractAssociatedIconExW(
        hInst: *mut core::ffi::c_void,  // HINSTANCE optional
        pszIconPath: *mut u16,  // LPWSTR 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.Unicode)]
public static extern IntPtr ExtractAssociatedIconExW(IntPtr hInst, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszIconPath, ref ushort piIconIndex, ref ushort piIconId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHELL32_ExtractAssociatedIconExW' -Namespace Win32 -PassThru
# $api::ExtractAssociatedIconExW(hInst, pszIconPath, piIconIndex, piIconId)

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

出力引数:

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