ホーム › UI.WindowsAndMessaging › LookupIconIdFromDirectoryEx

LookupIconIdFromDirectoryEx

関数

希望サイズに最適なアイコンのIDをディレクトリから取得する。

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

シグネチャ

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

INT LookupIconIdFromDirectoryEx(
    BYTE* presbits,
    BOOL fIcon,
    INT cxDesired,
    INT cyDesired,
    IMAGE_FLAGS Flags
);

パラメーター

名前

型

方向

説明

presbits

BYTE*

アイコンまたはカーソルのディレクトリデータです。この関数はリソースデータを検証しないため、presbits が有効なリソースデータを指していない場合は一般保護(GP)違反が発生するか、未定義の値が返されます。

fIcon

BOOL

アイコンとカーソルのどちらを探すかを示します。このパラメーターが TRUE の場合はアイコンを検索し、FALSE の場合はカーソルを検索します。

cxDesired

INT

希望するアイコンの幅(ピクセル単位)です。このパラメーターが 0 の場合、関数は SM_CXICON または SM_CXCURSOR のシステムメトリック値を使用します。

cyDesired

INT

希望するアイコンの高さ(ピクセル単位)です。このパラメーターが 0 の場合、関数は SM_CYICON または SM_CYCURSOR のシステムメトリック値を使用します。

Flags

IMAGE_FLAGS

以下の値の組み合わせです。

値	意味
LR_DEFAULTCOLOR 0x00000000	既定の色形式を使用します。
LR_MONOCHROME 0x00000001	モノクロのアイコンまたはカーソルを作成します。

戻り値の型: INT

公式ドキュメント

アイコンまたはカーソルのデータを検索し、現在の表示デバイスに最も適合するアイコンまたはカーソルを探します。(LookupIconIdFromDirectoryEx)

戻り値

型: int

関数が成功した場合、戻り値は現在の表示デバイスに最も適合するアイコン(RT_ICON)またはカーソル(RT_CURSOR)の整数リソース識別子です。

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

解説(Remarks)

RT_GROUP_ICON 型のリソースファイル(RT_GROUP_CURSOR はカーソルを示します)には、デバイス依存およびデバイス非依存の複数の形式でアイコン(またはカーソル)データが格納されています。LookupIconIdFromDirectoryEx は、リソースファイルから現在の表示デバイスに最も適合するアイコン(またはカーソル)を検索し、その整数識別子を返します。FindResource および FindResourceEx 関数は、この識別子とともに MAKEINTRESOURCE マクロを使用して、モジュール内のリソースを特定します。

アイコンディレクトリは、リソース型 RT_GROUP_ICON(カーソルの場合は RT_GROUP_CURSOR)のリソースファイルから読み込まれ、読み込む対象の特定のアイコン(RT_ICON)またはカーソル(RT_CURSOR)を表す整数リソース名が指定されます。 LoadResource および CreateIconFromResourceEx 関数を使用して、対応するアイコンまたはカーソルを作成できます。

LoadIcon、LoadImage、LoadCursor の各関数は、指定されたリソースデータから現在の表示デバイスに最も適合するアイコンまたはカーソルを検索するために、この関数を使用します。LoadIconWithScaleDown は、最適な適合のために別の検索基準を使用します。

使用例

使用例については、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>

INT LookupIconIdFromDirectoryEx(
    BYTE* presbits,
    BOOL fIcon,
    INT cxDesired,
    INT cyDesired,
    IMAGE_FLAGS Flags
);

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

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

' presbits : BYTE*
' fIcon : BOOL
' cxDesired : INT
' cyDesired : INT
' Flags : IMAGE_FLAGS
Declare PtrSafe Function LookupIconIdFromDirectoryEx Lib "user32" ( _
    ByVal presbits As LongPtr, _
    ByVal fIcon As Long, _
    ByVal cxDesired As Long, _
    ByVal cyDesired 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

LookupIconIdFromDirectoryEx = ctypes.windll.user32.LookupIconIdFromDirectoryEx
LookupIconIdFromDirectoryEx.restype = ctypes.c_int
LookupIconIdFromDirectoryEx.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # presbits : BYTE*
    wintypes.BOOL,  # fIcon : BOOL
    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')
LookupIconIdFromDirectoryEx = Fiddle::Function.new(
  lib['LookupIconIdFromDirectoryEx'],
  [
    Fiddle::TYPE_VOIDP,  # presbits : BYTE*
    Fiddle::TYPE_INT,  # fIcon : BOOL
    Fiddle::TYPE_INT,  # cxDesired : INT
    Fiddle::TYPE_INT,  # cyDesired : INT
    -Fiddle::TYPE_INT,  # Flags : IMAGE_FLAGS
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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