ホーム › UI.WindowsAndMessaging › PrivateExtractIconsA

PrivateExtractIconsA

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
szFileName	LPCSTR	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

公式ドキュメント

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

戻り値

型: UINT

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

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

解説(Remarks)

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

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

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

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

メモ

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

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

各言語での呼び出し定義

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

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

[DllImport("USER32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint PrivateExtractIconsA(
    [MarshalAs(UnmanagedType.LPStr)] string szFileName,   // LPCSTR
    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.Ansi, ExactSpelling:=True)>
Public Shared Function PrivateExtractIconsA(
    <MarshalAs(UnmanagedType.LPStr)> szFileName As String,   ' LPCSTR
    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 : LPCSTR
' nIconIndex : INT
' cxIcon : INT
' cyIcon : INT
' phicon : HICON* optional, out
' piconid : DWORD* optional, out
' nIcons : DWORD
' flags : DWORD
Declare PtrSafe Function PrivateExtractIconsA Lib "user32" ( _
    ByVal szFileName As String, _
    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
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

PrivateExtractIconsA = ctypes.windll.user32.PrivateExtractIconsA
PrivateExtractIconsA.restype = wintypes.DWORD
PrivateExtractIconsA.argtypes = [
    wintypes.LPCSTR,  # szFileName : LPCSTR
    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')
PrivateExtractIconsA = Fiddle::Function.new(
  lib['PrivateExtractIconsA'],
  [
    Fiddle::TYPE_VOIDP,  # szFileName : LPCSTR
    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)

#[link(name = "user32")]
extern "system" {
    fn PrivateExtractIconsA(
        szFileName: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint PrivateExtractIconsA([MarshalAs(UnmanagedType.LPStr)] string szFileName, int nIconIndex, int cxIcon, int cyIcon, IntPtr phicon, IntPtr piconid, uint nIcons, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_PrivateExtractIconsA' -Namespace Win32 -PassThru
# $api::PrivateExtractIconsA(szFileName, nIconIndex, cxIcon, cyIcon, phicon, piconid, nIcons, flags)

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

出力引数:

#uselib "USER32.dll"
#cfunc global PrivateExtractIconsA "PrivateExtractIconsA" str, int, int, int, sptr, var, int, int
; res = PrivateExtractIconsA(szFileName, nIconIndex, cxIcon, cyIcon, phicon, piconid, nIcons, flags)
; szFileName : LPCSTR -> "str"
; 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 PrivateExtractIconsA "PrivateExtractIconsA" str, int, int, int, sptr, sptr, int, int
; res = PrivateExtractIconsA(szFileName, nIconIndex, cxIcon, cyIcon, phicon, varptr(piconid), nIcons, flags)
; szFileName : LPCSTR -> "str"
; 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(変数))。