ホーム › UI.WindowsAndMessaging › PrivateExtractIconsW

PrivateExtractIconsW

関数

ファイルから指定サイズのアイコンを複数抽出する(Unicode版)。

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

シグネチャ

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

DWORD PrivateExtractIconsW(
    LPCWSTR szFileName,
    INT nIconIndex,
    INT cxIcon,
    INT cyIcon,
    HICON* phicon,   // optional
    DWORD* piconid,   // optional
    DWORD nIcons,
    DWORD flags
);

パラメーター

名前	型	方向	説明
szFileName	LPCWSTR	in	アイコンを抽出する対象ファイルのパスと名前。
nIconIndex	INT	in	最初に抽出するアイコンの 0 から始まるインデックス。たとえばこの値が 0 の場合、関数は指定したファイル内の最初のアイコンを抽出します。
cxIcon	INT	in	必要とするアイコンの水平方向のサイズ。「解説」を参照してください。
cyIcon	INT	in	必要とするアイコンの垂直方向のサイズ。「解説」を参照してください。
phicon	HICON*	outoptional	返されるアイコンハンドルの配列へのポインター。
piconid	DWORD*	outoptional	現在の表示デバイスに最も適したアイコンの、返されるリソース識別子へのポインター。この形式で識別子が利用できない場合、返される識別子は 0xFFFFFFFF になります。識別子をそれ以外の方法でも取得できない場合、返される識別子は 0 になります。
nIcons	DWORD	in	ファイルから抽出するアイコンの数。このパラメーターは、.exe ファイルおよび .dll ファイルから抽出する場合にのみ有効です。
flags	DWORD	in	この関数を制御するフラグを指定します。これらのフラグは、LoadImage 関数で使用される LR_* フラグです。

戻り値の型: DWORD

公式ドキュメント

指定したファイルから抽出したアイコンのハンドルの配列を作成します。(Unicode)

戻り値

型: UINT

phicon パラメーターが NULL で、この関数が成功した場合、戻り値はファイル内のアイコンの数です。関数が失敗した場合、戻り値は 0 です。

phicon パラメーターが NULL 以外で、関数が成功した場合、戻り値は抽出されたアイコンの数です。それ以外の場合、ファイルが見つからなければ戻り値は 0xFFFFFFFF になります。

解説(Remarks)

この関数は、実行可能ファイル (.exe)、DLL (.dll)、アイコン (.ico)、カーソル (.cur)、アニメーションカーソル (.ani)、ビットマップ (.bmp) の各ファイルから抽出を行います。Windows 3.x の 16 ビット実行可能ファイル (.exe または .dll) からの抽出もサポートされています。

cxIcon および cyIcon パラメーターは、抽出するアイコンのサイズを指定します。パラメーターの LOWORD に 1 つ目のサイズ、HIWORD に 2 つ目のサイズを設定することで、2 つのサイズを抽出できます。たとえば、cxIcon と cyIcon の両パラメーターに MAKELONG(24, 48) を指定すると、24 と 48 の両方のサイズのアイコンが抽出されます。

PrivateExtractIcons で抽出したすべてのアイコンは、DestroyIcon 関数を呼び出して破棄する必要があります。

この関数は、Windows XP Service Pack 1 (SP1) および Windows Server 2003 まで SDK のヘッダーおよびライブラリに含まれていませんでした。この関数用のヘッダーファイルとインポートライブラリがない場合は、LoadLibrary および GetProcAddress を使用してこの関数を呼び出すことができます。

メモ

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

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

各言語での呼び出し定義

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

DWORD PrivateExtractIconsW(
    LPCWSTR szFileName,
    INT nIconIndex,
    INT cxIcon,
    INT cyIcon,
    HICON* phicon,   // optional
    DWORD* piconid,   // optional
    DWORD nIcons,
    DWORD flags
);

[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint PrivateExtractIconsW(
    [MarshalAs(UnmanagedType.LPWStr)] string szFileName,   // LPCWSTR
    int nIconIndex,   // INT
    int cxIcon,   // INT
    int cyIcon,   // INT
    IntPtr phicon,   // HICON* optional, out
    IntPtr piconid,   // DWORD* optional, out
    uint nIcons,   // DWORD
    uint flags   // DWORD
);

<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function PrivateExtractIconsW(
    <MarshalAs(UnmanagedType.LPWStr)> szFileName As String,   ' LPCWSTR
    nIconIndex As Integer,   ' INT
    cxIcon As Integer,   ' INT
    cyIcon As Integer,   ' INT
    phicon As IntPtr,   ' HICON* optional, out
    piconid As IntPtr,   ' DWORD* optional, out
    nIcons As UInteger,   ' DWORD
    flags As UInteger   ' DWORD
) As UInteger
End Function

' szFileName : LPCWSTR
' nIconIndex : INT
' cxIcon : INT
' cyIcon : INT
' phicon : HICON* optional, out
' piconid : DWORD* optional, out
' nIcons : DWORD
' flags : DWORD
Declare PtrSafe Function PrivateExtractIconsW Lib "user32" ( _
    ByVal szFileName As LongPtr, _
    ByVal nIconIndex As Long, _
    ByVal cxIcon As Long, _
    ByVal cyIcon As Long, _
    ByVal phicon As LongPtr, _
    ByVal piconid As LongPtr, _
    ByVal nIcons As Long, _
    ByVal flags 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

PrivateExtractIconsW = ctypes.windll.user32.PrivateExtractIconsW
PrivateExtractIconsW.restype = wintypes.DWORD
PrivateExtractIconsW.argtypes = [
    wintypes.LPCWSTR,  # szFileName : LPCWSTR
    ctypes.c_int,  # nIconIndex : INT
    ctypes.c_int,  # cxIcon : INT
    ctypes.c_int,  # cyIcon : INT
    ctypes.c_void_p,  # phicon : HICON* optional, out
    ctypes.POINTER(wintypes.DWORD),  # piconid : DWORD* optional, out
    wintypes.DWORD,  # nIcons : DWORD
    wintypes.DWORD,  # flags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
PrivateExtractIconsW = Fiddle::Function.new(
  lib['PrivateExtractIconsW'],
  [
    Fiddle::TYPE_VOIDP,  # szFileName : LPCWSTR
    Fiddle::TYPE_INT,  # nIconIndex : INT
    Fiddle::TYPE_INT,  # cxIcon : INT
    Fiddle::TYPE_INT,  # cyIcon : INT
    Fiddle::TYPE_VOIDP,  # phicon : HICON* optional, out
    Fiddle::TYPE_VOIDP,  # piconid : DWORD* optional, out
    -Fiddle::TYPE_INT,  # nIcons : DWORD
    -Fiddle::TYPE_INT,  # flags : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "user32")]
extern "system" {
    fn PrivateExtractIconsW(
        szFileName: *const u16,  // LPCWSTR
        nIconIndex: i32,  // INT
        cxIcon: i32,  // INT
        cyIcon: i32,  // INT
        phicon: *mut *mut core::ffi::c_void,  // HICON* optional, out
        piconid: *mut u32,  // DWORD* optional, out
        nIcons: u32,  // DWORD
        flags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern uint PrivateExtractIconsW([MarshalAs(UnmanagedType.LPWStr)] string szFileName, int nIconIndex, int cxIcon, int cyIcon, IntPtr phicon, IntPtr piconid, uint nIcons, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_PrivateExtractIconsW' -Namespace Win32 -PassThru
# $api::PrivateExtractIconsW(szFileName, nIconIndex, cxIcon, cyIcon, phicon, piconid, nIcons, flags)

#uselib "USER32.dll"
#func global PrivateExtractIconsW "PrivateExtractIconsW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; PrivateExtractIconsW szFileName, nIconIndex, cxIcon, cyIcon, phicon, varptr(piconid), nIcons, flags   ; 戻り値は stat
; szFileName : LPCWSTR -> "wptr"
; nIconIndex : INT -> "wptr"
; cxIcon : INT -> "wptr"
; cyIcon : INT -> "wptr"
; phicon : HICON* optional, out -> "wptr"
; piconid : DWORD* optional, out -> "wptr"
; nIcons : DWORD -> "wptr"
; flags : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global PrivateExtractIconsW "PrivateExtractIconsW" wstr, int, int, int, sptr, var, int, int
; res = PrivateExtractIconsW(szFileName, nIconIndex, cxIcon, cyIcon, phicon, piconid, nIcons, flags)
; szFileName : LPCWSTR -> "wstr"
; nIconIndex : INT -> "int"
; cxIcon : INT -> "int"
; cyIcon : INT -> "int"
; phicon : HICON* optional, out -> "sptr"
; piconid : DWORD* optional, out -> "var"
; nIcons : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global PrivateExtractIconsW "PrivateExtractIconsW" wstr, int, int, int, sptr, sptr, int, int
; res = PrivateExtractIconsW(szFileName, nIconIndex, cxIcon, cyIcon, phicon, varptr(piconid), nIcons, flags)
; szFileName : LPCWSTR -> "wstr"
; nIconIndex : INT -> "int"
; cxIcon : INT -> "int"
; cyIcon : INT -> "int"
; phicon : HICON* optional, out -> "sptr"
; piconid : DWORD* optional, out -> "sptr"
; nIcons : DWORD -> "int"
; flags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。