ホーム › UI.WindowsAndMessaging › CreateIconFromResourceEx

CreateIconFromResourceEx

関数

希望サイズを指定してリソースからアイコンを作成する。

DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll
#include <windows.h>

HICON CreateIconFromResourceEx(
    BYTE* presbits,
    DWORD dwResSize,
    BOOL fIcon,
    DWORD dwVer,
    INT cxDesired,
    INT cyDesired,
    IMAGE_FLAGS Flags
);

パラメーター

名前

型

方向

説明

presbits

BYTE*

アイコン(RT_ICON)またはカーソル(RT_CURSOR)のリソースビットを格納する、DWORD 境界に整列されたバッファーへのポインターです。これらのビットは通常、LookupIconIdFromDirectoryEx 関数および LoadResource 関数の呼び出しによって読み込まれます。

アイコンおよびカーソルのリソース形式の詳細については、Cursor and Icon Resources を参照してください。

dwResSize

DWORD

pbIconBits パラメーターが指すビット集合のサイズ(バイト単位)です。

fIcon

BOOL

アイコンとカーソルのどちらを作成するかを指定します。このパラメーターが TRUE の場合はアイコンが作成されます。FALSE の場合はカーソルが作成されます。

LOCALHEADER 構造体はカーソルのホットスポットを定義し、カーソルのリソースビットから最初に読み取られるデータです。

dwVer

DWORD

presbits パラメーターが指すリソースビットのアイコンまたはカーソル形式のバージョン番号です。この値は 0x00020000 以上 0x00030000 以下でなければなりません。通常、このパラメーターには 0x00030000 を設定します。

cxDesired

INT

アイコンまたはカーソルの幅(ピクセル単位)です。このパラメーターが 0 で、Flags パラメーターに LR_DEFAULTSIZE が指定されている場合、この関数は SM_CXICON または SM_CXCURSOR のシステムメトリック値を使用して幅を設定します。このパラメーターが 0 で、LR_DEFAULTSIZE が使用されていない場合、この関数は実際のリソースの幅を使用します。

cyDesired

INT

アイコンまたはカーソルの高さ(ピクセル単位)です。このパラメーターが 0 で、Flags パラメーターに LR_DEFAULTSIZE が指定されている場合、この関数は SM_CYICON または SM_CYCURSOR のシステムメトリック値を使用して高さを設定します。このパラメーターが 0 で、LR_DEFAULTSIZE が使用されていない場合、この関数は実際のリソースの高さを使用します。

Flags

IMAGE_FLAGS

次の値の組み合わせです。

値	意味
LR_DEFAULTCOLOR 0x00000000	既定の色形式を使用します。
LR_DEFAULTSIZE 0x00000040	cxDesired または cyDesired の値が 0 に設定されている場合に、カーソルまたはアイコンのシステムメトリック値で指定された幅または高さを使用します。このフラグが指定されておらず、cxDesired と cyDesired が 0 に設定されている場合、この関数は実際のリソースのサイズを使用します。
LR_MONOCHROME 0x00000001	モノクロのアイコンまたはカーソルを作成します。
LR_SHARED 0x00008000	アイコンまたはカーソルが複数回作成される場合に、そのハンドルを共有します。LR_SHARED が設定されていない場合、同じリソースに対して CreateIconFromResourceEx を 2 回目に呼び出すと、アイコンまたはカーソルが再度作成され、異なるハンドルが返されます。このフラグを使用すると、リソースが不要になったときにシステムがそれを破棄します。非標準のサイズを持つアイコンやカーソル、読み込み後に変更される可能性があるもの、またはファイルから読み込まれるものに対しては、LR_SHARED を使用しないでください。

戻り値の型: HICON

公式ドキュメント

アイコンを記述したリソースビットからアイコンまたはカーソルを作成します。(CreateIconFromResourceEx)

戻り値

型: HICON

関数が成功した場合、戻り値はアイコンまたはカーソルへのハンドルです。

関数が失敗した場合、戻り値は NULL です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

CreateIconFromResource、CreateIconFromResourceEx、CreateIconIndirect、GetIconInfo、および LookupIconIdFromDirectoryEx の各関数を使用すると、シェルアプリケーションやアイコンブラウザーがシステム全体のリソースを調査して利用できます。

CreateIconFromResourceEx で作成したアイコンに対しては DestroyIcon を、カーソルに対しては DestroyCursor を呼び出してください。

例

例については、Sharing Icon Resources を参照してください。

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

各言語での呼び出し定義

// USER32.dll
#include <windows.h>

HICON CreateIconFromResourceEx(
    BYTE* presbits,
    DWORD dwResSize,
    BOOL fIcon,
    DWORD dwVer,
    INT cxDesired,
    INT cyDesired,
    IMAGE_FLAGS Flags
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateIconFromResourceEx(
    IntPtr presbits,   // BYTE*
    uint dwResSize,   // DWORD
    bool fIcon,   // BOOL
    uint dwVer,   // DWORD
    int cxDesired,   // INT
    int cyDesired,   // INT
    uint Flags   // IMAGE_FLAGS
);

<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateIconFromResourceEx(
    presbits As IntPtr,   ' BYTE*
    dwResSize As UInteger,   ' DWORD
    fIcon As Boolean,   ' BOOL
    dwVer As UInteger,   ' DWORD
    cxDesired As Integer,   ' INT
    cyDesired As Integer,   ' INT
    Flags As UInteger   ' IMAGE_FLAGS
) As IntPtr
End Function

' presbits : BYTE*
' dwResSize : DWORD
' fIcon : BOOL
' dwVer : DWORD
' cxDesired : INT
' cyDesired : INT
' Flags : IMAGE_FLAGS
Declare PtrSafe Function CreateIconFromResourceEx Lib "user32" ( _
    ByVal presbits As LongPtr, _
    ByVal dwResSize As Long, _
    ByVal fIcon As Long, _
    ByVal dwVer As Long, _
    ByVal cxDesired As Long, _
    ByVal cyDesired As Long, _
    ByVal Flags As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

CreateIconFromResourceEx = ctypes.windll.user32.CreateIconFromResourceEx
CreateIconFromResourceEx.restype = ctypes.c_void_p
CreateIconFromResourceEx.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # presbits : BYTE*
    wintypes.DWORD,  # dwResSize : DWORD
    wintypes.BOOL,  # fIcon : BOOL
    wintypes.DWORD,  # dwVer : DWORD
    ctypes.c_int,  # cxDesired : INT
    ctypes.c_int,  # cyDesired : INT
    wintypes.DWORD,  # Flags : IMAGE_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
CreateIconFromResourceEx = Fiddle::Function.new(
  lib['CreateIconFromResourceEx'],
  [
    Fiddle::TYPE_VOIDP,  # presbits : BYTE*
    -Fiddle::TYPE_INT,  # dwResSize : DWORD
    Fiddle::TYPE_INT,  # fIcon : BOOL
    -Fiddle::TYPE_INT,  # dwVer : DWORD
    Fiddle::TYPE_INT,  # cxDesired : INT
    Fiddle::TYPE_INT,  # cyDesired : INT
    -Fiddle::TYPE_INT,  # Flags : IMAGE_FLAGS
  ],
  Fiddle::TYPE_VOIDP)

#[link(name = "user32")]
extern "system" {
    fn CreateIconFromResourceEx(
        presbits: *mut u8,  // BYTE*
        dwResSize: u32,  // DWORD
        fIcon: i32,  // BOOL
        dwVer: u32,  // DWORD
        cxDesired: i32,  // INT
        cyDesired: i32,  // INT
        Flags: u32  // IMAGE_FLAGS
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern IntPtr CreateIconFromResourceEx(IntPtr presbits, uint dwResSize, bool fIcon, uint dwVer, int cxDesired, int cyDesired, uint Flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CreateIconFromResourceEx' -Namespace Win32 -PassThru
# $api::CreateIconFromResourceEx(presbits, dwResSize, fIcon, dwVer, cxDesired, cyDesired, Flags)

#uselib "USER32.dll"
#func global CreateIconFromResourceEx "CreateIconFromResourceEx" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; CreateIconFromResourceEx varptr(presbits), dwResSize, fIcon, dwVer, cxDesired, cyDesired, Flags   ; 戻り値は stat
; presbits : BYTE* -> "sptr"
; dwResSize : DWORD -> "sptr"
; fIcon : BOOL -> "sptr"
; dwVer : DWORD -> "sptr"
; cxDesired : INT -> "sptr"
; cyDesired : INT -> "sptr"
; Flags : IMAGE_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USER32.dll"
#cfunc global CreateIconFromResourceEx "CreateIconFromResourceEx" var, int, int, int, int, int, int
; res = CreateIconFromResourceEx(presbits, dwResSize, fIcon, dwVer, cxDesired, cyDesired, Flags)
; presbits : BYTE* -> "var"
; dwResSize : DWORD -> "int"
; fIcon : BOOL -> "int"
; dwVer : DWORD -> "int"
; cxDesired : INT -> "int"
; cyDesired : INT -> "int"
; Flags : IMAGE_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USER32.dll"
#cfunc global CreateIconFromResourceEx "CreateIconFromResourceEx" sptr, int, int, int, int, int, int
; res = CreateIconFromResourceEx(varptr(presbits), dwResSize, fIcon, dwVer, cxDesired, cyDesired, Flags)
; presbits : BYTE* -> "sptr"
; dwResSize : DWORD -> "int"
; fIcon : BOOL -> "int"
; dwVer : DWORD -> "int"
; cxDesired : INT -> "int"
; cyDesired : INT -> "int"
; Flags : IMAGE_FLAGS -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。