Win32 API 日本語リファレンス
ホームUI.WindowsAndMessaging › LookupIconIdFromDirectory

LookupIconIdFromDirectory

関数
アイコンディレクトリから最適なアイコンのIDを取得する。
DLLUSER32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

INT LookupIconIdFromDirectory(
    BYTE* presbits,
    BOOL fIcon
);

パラメーター

名前方向説明
presbitsBYTE*inアイコンまたはカーソルのディレクトリ データです。この関数はリソース データを検証しないため、presbits が有効なリソース データを指していない場合、一般保護 (GP) 違反が発生するか、未定義の値が返されます。
fIconBOOLinアイコンとカーソルのどちらを検索するかを示します。このパラメーターが TRUE の場合、関数はアイコンを検索します。FALSE の場合、関数はカーソルを検索します。

戻り値の型: INT

公式ドキュメント

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

戻り値

型: int

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

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

解説(Remarks)

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

アイコン ディレクトリは、リソース型 RT_GROUP_ICON (カーソルの場合は RT_GROUP_CURSOR) のリソース ファイルから読み込まれ、読み込む特定のアイコンを示す整数リソース名を伴います。LookupIconIdFromDirectory は、現在の表示デバイスに最も適したアイコンのリソース名となる整数識別子を返します。

LoadIconLoadCursor、および LoadImage の各関数は、この関数を使用して、指定されたリソース データの中から現在の表示デバイスに最も適したアイコンまたはカーソルを検索します。

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

各言語での呼び出し定義

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

INT LookupIconIdFromDirectory(
    BYTE* presbits,
    BOOL fIcon
);
[DllImport("USER32.dll", SetLastError = true, ExactSpelling = true)]
static extern int LookupIconIdFromDirectory(
    IntPtr presbits,   // BYTE*
    bool fIcon   // BOOL
);
<DllImport("USER32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LookupIconIdFromDirectory(
    presbits As IntPtr,   ' BYTE*
    fIcon As Boolean   ' BOOL
) As Integer
End Function
' presbits : BYTE*
' fIcon : BOOL
Declare PtrSafe Function LookupIconIdFromDirectory Lib "user32" ( _
    ByVal presbits As LongPtr, _
    ByVal fIcon As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LookupIconIdFromDirectory = ctypes.windll.user32.LookupIconIdFromDirectory
LookupIconIdFromDirectory.restype = ctypes.c_int
LookupIconIdFromDirectory.argtypes = [
    ctypes.POINTER(ctypes.c_ubyte),  # presbits : BYTE*
    wintypes.BOOL,  # fIcon : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LookupIconIdFromDirectory = Fiddle::Function.new(
  lib['LookupIconIdFromDirectory'],
  [
    Fiddle::TYPE_VOIDP,  # presbits : BYTE*
    Fiddle::TYPE_INT,  # fIcon : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "user32")]
extern "system" {
    fn LookupIconIdFromDirectory(
        presbits: *mut u8,  // BYTE*
        fIcon: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", SetLastError = true)]
public static extern int LookupIconIdFromDirectory(IntPtr presbits, bool fIcon);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LookupIconIdFromDirectory' -Namespace Win32 -PassThru
# $api::LookupIconIdFromDirectory(presbits, fIcon)
#uselib "USER32.dll"
#func global LookupIconIdFromDirectory "LookupIconIdFromDirectory" sptr, sptr
; LookupIconIdFromDirectory varptr(presbits), fIcon   ; 戻り値は stat
; presbits : BYTE* -> "sptr"
; fIcon : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USER32.dll"
#cfunc global LookupIconIdFromDirectory "LookupIconIdFromDirectory" var, int
; res = LookupIconIdFromDirectory(presbits, fIcon)
; presbits : BYTE* -> "var"
; fIcon : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT LookupIconIdFromDirectory(BYTE* presbits, BOOL fIcon)
#uselib "USER32.dll"
#cfunc global LookupIconIdFromDirectory "LookupIconIdFromDirectory" var, int
; res = LookupIconIdFromDirectory(presbits, fIcon)
; presbits : BYTE* -> "var"
; fIcon : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLookupIconIdFromDirectory = user32.NewProc("LookupIconIdFromDirectory")
)

// presbits (BYTE*), fIcon (BOOL)
r1, _, err := procLookupIconIdFromDirectory.Call(
	uintptr(presbits),
	uintptr(fIcon),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function LookupIconIdFromDirectory(
  presbits: Pointer;   // BYTE*
  fIcon: BOOL   // BOOL
): Integer; stdcall;
  external 'USER32.dll' name 'LookupIconIdFromDirectory';
result := DllCall("USER32\LookupIconIdFromDirectory"
    , "Ptr", presbits   ; BYTE*
    , "Int", fIcon   ; BOOL
    , "Int")   ; return: INT
●LookupIconIdFromDirectory(presbits, fIcon) = DLL("USER32.dll", "int LookupIconIdFromDirectory(void*, bool)")
# 呼び出し: LookupIconIdFromDirectory(presbits, fIcon)
# presbits : BYTE* -> "void*"
# fIcon : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn LookupIconIdFromDirectory(
    presbits: [*c]u8, // BYTE*
    fIcon: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
proc LookupIconIdFromDirectory(
    presbits: ptr uint8,  # BYTE*
    fIcon: int32  # BOOL
): int32 {.importc: "LookupIconIdFromDirectory", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
int LookupIconIdFromDirectory(
    ubyte* presbits,   // BYTE*
    int fIcon   // BOOL
);
ccall((:LookupIconIdFromDirectory, "USER32.dll"), stdcall, Int32,
      (Ptr{UInt8}, Int32),
      presbits, fIcon)
# presbits : BYTE* -> Ptr{UInt8}
# fIcon : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t LookupIconIdFromDirectory(
    uint8_t* presbits,
    int32_t fIcon);
]]
local user32 = ffi.load("user32")
-- user32.LookupIconIdFromDirectory(presbits, fIcon)
-- presbits : BYTE*
-- fIcon : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LookupIconIdFromDirectory = lib.func('__stdcall', 'LookupIconIdFromDirectory', 'int32_t', ['uint8_t *', 'int32_t']);
// LookupIconIdFromDirectory(presbits, fIcon)
// presbits : BYTE* -> 'uint8_t *'
// fIcon : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LookupIconIdFromDirectory: { parameters: ["pointer", "i32"], result: "i32" },
});
// lib.symbols.LookupIconIdFromDirectory(presbits, fIcon)
// presbits : BYTE* -> "pointer"
// fIcon : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t LookupIconIdFromDirectory(
    uint8_t* presbits,
    int32_t fIcon);
C, "USER32.dll");
// $ffi->LookupIconIdFromDirectory(presbits, fIcon);
// presbits : BYTE*
// fIcon : BOOL
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface User32 extends StdCallLibrary {
    User32 INSTANCE = Native.load("user32", User32.class);
    int LookupIconIdFromDirectory(
        byte[] presbits,   // BYTE*
        boolean fIcon   // BOOL
    );
}
@[Link("user32")]
lib LibUSER32
  fun LookupIconIdFromDirectory = LookupIconIdFromDirectory(
    presbits : UInt8*,   # BYTE*
    fIcon : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LookupIconIdFromDirectoryNative = Int32 Function(Pointer<Uint8>, Int32);
typedef LookupIconIdFromDirectoryDart = int Function(Pointer<Uint8>, int);
final LookupIconIdFromDirectory = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LookupIconIdFromDirectoryNative, LookupIconIdFromDirectoryDart>('LookupIconIdFromDirectory');
// presbits : BYTE* -> Pointer<Uint8>
// fIcon : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LookupIconIdFromDirectory(
  presbits: Pointer;   // BYTE*
  fIcon: BOOL   // BOOL
): Integer; stdcall;
  external 'USER32.dll' name 'LookupIconIdFromDirectory';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LookupIconIdFromDirectory"
  c_LookupIconIdFromDirectory :: Ptr Word8 -> CInt -> IO Int32
-- presbits : BYTE* -> Ptr Word8
-- fIcon : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lookupiconidfromdirectory =
  foreign "LookupIconIdFromDirectory"
    ((ptr uint8_t) @-> int32_t @-> returning int32_t)
(* presbits : BYTE* -> (ptr uint8_t) *)
(* fIcon : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("LookupIconIdFromDirectory" lookup-icon-id-from-directory :convention :stdcall) :int32
  (presbits :pointer)   ; BYTE*
  (f-icon :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LookupIconIdFromDirectory = Win32::API::More->new('USER32',
    'int LookupIconIdFromDirectory(LPVOID presbits, BOOL fIcon)');
# my $ret = $LookupIconIdFromDirectory->Call($presbits, $fIcon);
# presbits : BYTE* -> LPVOID
# fIcon : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目