ホーム › UI.WindowsAndMessaging › CreateIconFromResource

CreateIconFromResource

関数

リソースビットからアイコンまたはカーソルを作成する。

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

シグネチャ

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

HICON CreateIconFromResource(
    BYTE* presbits,
    DWORD dwResSize,
    BOOL fIcon,
    DWORD dwVer
);

パラメーター

名前	型	方向	説明
presbits	BYTE*	in	アイコンまたはカーソルのリソースビットを格納する、DWORD 境界に整列したバッファへのポインターです。これらのビットは通常、LookupIconIdFromDirectory、LookupIconIdFromDirectoryEx、LoadResource の各関数を呼び出すことで読み込まれます。アイコンおよびカーソルのリソース形式の詳細については、Cursor and Icon Resources を参照してください。
dwResSize	DWORD	in	presbits パラメーターが指すビット列のサイズ(バイト単位)です。
fIcon	BOOL	in	アイコンとカーソルのどちらを作成するかを指定します。このパラメーターが TRUE の場合はアイコンが作成されます。FALSE の場合はカーソルが作成されます。 LOCALHEADER 構造体はカーソルのホットスポットを定義しており、カーソルのリソースビットから最初に読み取られるデータです。
dwVer	DWORD	in	presbits パラメーターが指すリソースビットのアイコンまたはカーソル形式のバージョン番号です。値は 0x00020000 以上 0x00030000 以下でなければなりません。このパラメーターには通常 0x00030000 を設定します。

戻り値の型: HICON

公式ドキュメント

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

戻り値

型: HICON

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

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

解説(Remarks)

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

CreateIconFromResource 関数は、フラグとして LR_DEFAULTSIZE|LR_SHARED を渡して CreateIconFromResourceEx を呼び出します。

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

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

各言語での呼び出し定義

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

HICON CreateIconFromResource(
    BYTE* presbits,
    DWORD dwResSize,
    BOOL fIcon,
    DWORD dwVer
);

[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateIconFromResource(
    IntPtr presbits,   // BYTE*
    uint dwResSize,   // DWORD
    bool fIcon,   // BOOL
    uint dwVer   // DWORD
);

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "user32")]
extern "system" {
    fn CreateIconFromResource(
        presbits: *mut u8,  // BYTE*
        dwResSize: u32,  // DWORD
        fIcon: i32,  // BOOL
        dwVer: u32  // DWORD
    ) -> *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 CreateIconFromResource(IntPtr presbits, uint dwResSize, bool fIcon, uint dwVer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_CreateIconFromResource' -Namespace Win32 -PassThru
# $api::CreateIconFromResource(presbits, dwResSize, fIcon, dwVer)

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

出力引数:

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