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

LoadIconMetric

関数
システムメトリックに合わせたサイズでアイコンを読み込む。
DLLCOMCTL32.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT LoadIconMetric(
    HINSTANCE hinst,   // optional
    LPCWSTR pszName,
    _LI_METRIC lims,
    HICON* phico
);

パラメーター

名前方向説明
hinstHINSTANCEinoptional

読み込むアイコンを含む DLL または実行可能ファイル (.exe) のモジュールへのハンドル。詳細については、GetModuleHandle を参照してください。

定義済みのシステムアイコン、または単独のアイコンファイルを読み込むには、このパラメーターを NULL に設定します。

pszNameLPCWSTRin

読み込むアイコンの位置情報を含む、null 終端の Unicode バッファーへのポインター。

hinstNULL 以外の場合、pszName はアイコンリソースを名前または序数で指定します。この序数は MAKEINTRESOURCE マクロを使用してパッケージ化する必要があります。

hinstNULL の場合、pszName は読み込む定義済みシステムアイコンの識別子 (IDI_ プレフィックスで始まる)を指定します。

lims_LI_METRICin

目的のメトリック。次のいずれかの値を指定します。

Value Meaning
LIM_SMALL
小さいアイコンの推奨ピクセル幅である SM_CXSMICON に対応します。
LIM_LARGE
アイコンの既定のピクセル幅である SM_CXICON に対応します。
phicoHICON*outこの関数が戻るとき、読み込まれたアイコンのハンドルへのポインターが格納されます。

戻り値の型: HRESULT

公式ドキュメント

指定したアイコンリソースを、クライアントが指定したシステムメトリックで読み込みます。

戻り値

型: HRESULT

成功した場合は S_OK を返します。それ以外の場合は、次の値を含むエラーを返します。

Return code Description
E_INVALIDARG
pszName が指すバッファーの内容が、想定されるいずれの解釈にも一致しません。

解説(Remarks)

LoadIconMetricLoadIcon と似ていますが、アイコンメトリックを指定できる点が異なります。呼び出し元のアプリケーションが高品質なアイコンを確実に取得したい場合に、LoadIcon の代わりに使用します。これは、高い dpi (1 インチあたりのドット数) の状況で特に役立ちます。

アイコンは次のように抽出または作成されます。

  1. リソース内にサイズが完全に一致するものが見つかった場合は、そのアイコンが使用されます。
  2. サイズが完全に一致するものが見つからず、より大きいアイコンが利用可能な場合は、その大きいバージョンを目的のサイズに縮小して新しいアイコンが作成されます。
  3. サイズが完全に一致するものが見つからず、より大きいアイコンも利用できない場合は、より小さいアイコンを目的のサイズに拡大して新しいアイコンが作成されます。
LoadIconMetricLoadIcon を比較した呼び出し例を以下に示します。
NOTIFYICONDATA  nidIconData  = {0};
nidIconData.hIcon = LoadIcon(hInstance, MAKEINTRESOURCE(IDI_ICON));

// Or...

HRESULT hr = LoadIconMetric(hInstance, MAKEINTRESOURCE(IDI_ICON), LIM_SMALL, &nidIconData.hIcon);

取得したアイコンに対して DestroyIcon を呼び出すのは、アプリケーションの責任です。

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

各言語での呼び出し定義

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

HRESULT LoadIconMetric(
    HINSTANCE hinst,   // optional
    LPCWSTR pszName,
    _LI_METRIC lims,
    HICON* phico
);
[DllImport("COMCTL32.dll", ExactSpelling = true)]
static extern int LoadIconMetric(
    IntPtr hinst,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPWStr)] string pszName,   // LPCWSTR
    int lims,   // _LI_METRIC
    IntPtr phico   // HICON* out
);
<DllImport("COMCTL32.dll", ExactSpelling:=True)>
Public Shared Function LoadIconMetric(
    hinst As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPWStr)> pszName As String,   ' LPCWSTR
    lims As Integer,   ' _LI_METRIC
    phico As IntPtr   ' HICON* out
) As Integer
End Function
' hinst : HINSTANCE optional
' pszName : LPCWSTR
' lims : _LI_METRIC
' phico : HICON* out
Declare PtrSafe Function LoadIconMetric Lib "comctl32" ( _
    ByVal hinst As LongPtr, _
    ByVal pszName As LongPtr, _
    ByVal lims As Long, _
    ByVal phico As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadIconMetric = ctypes.windll.comctl32.LoadIconMetric
LoadIconMetric.restype = ctypes.c_int
LoadIconMetric.argtypes = [
    wintypes.HANDLE,  # hinst : HINSTANCE optional
    wintypes.LPCWSTR,  # pszName : LPCWSTR
    ctypes.c_int,  # lims : _LI_METRIC
    ctypes.c_void_p,  # phico : HICON* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('COMCTL32.dll')
LoadIconMetric = Fiddle::Function.new(
  lib['LoadIconMetric'],
  [
    Fiddle::TYPE_VOIDP,  # hinst : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # pszName : LPCWSTR
    Fiddle::TYPE_INT,  # lims : _LI_METRIC
    Fiddle::TYPE_VOIDP,  # phico : HICON* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "comctl32")]
extern "system" {
    fn LoadIconMetric(
        hinst: *mut core::ffi::c_void,  // HINSTANCE optional
        pszName: *const u16,  // LPCWSTR
        lims: i32,  // _LI_METRIC
        phico: *mut *mut core::ffi::c_void  // HICON* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("COMCTL32.dll")]
public static extern int LoadIconMetric(IntPtr hinst, [MarshalAs(UnmanagedType.LPWStr)] string pszName, int lims, IntPtr phico);
"@
$api = Add-Type -MemberDefinition $sig -Name 'COMCTL32_LoadIconMetric' -Namespace Win32 -PassThru
# $api::LoadIconMetric(hinst, pszName, lims, phico)
#uselib "COMCTL32.dll"
#func global LoadIconMetric "LoadIconMetric" sptr, sptr, sptr, sptr
; LoadIconMetric hinst, pszName, lims, phico   ; 戻り値は stat
; hinst : HINSTANCE optional -> "sptr"
; pszName : LPCWSTR -> "sptr"
; lims : _LI_METRIC -> "sptr"
; phico : HICON* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "COMCTL32.dll"
#cfunc global LoadIconMetric "LoadIconMetric" sptr, wstr, int, sptr
; res = LoadIconMetric(hinst, pszName, lims, phico)
; hinst : HINSTANCE optional -> "sptr"
; pszName : LPCWSTR -> "wstr"
; lims : _LI_METRIC -> "int"
; phico : HICON* out -> "sptr"
; HRESULT LoadIconMetric(HINSTANCE hinst, LPCWSTR pszName, _LI_METRIC lims, HICON* phico)
#uselib "COMCTL32.dll"
#cfunc global LoadIconMetric "LoadIconMetric" intptr, wstr, int, intptr
; res = LoadIconMetric(hinst, pszName, lims, phico)
; hinst : HINSTANCE optional -> "intptr"
; pszName : LPCWSTR -> "wstr"
; lims : _LI_METRIC -> "int"
; phico : HICON* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	comctl32 = windows.NewLazySystemDLL("COMCTL32.dll")
	procLoadIconMetric = comctl32.NewProc("LoadIconMetric")
)

// hinst (HINSTANCE optional), pszName (LPCWSTR), lims (_LI_METRIC), phico (HICON* out)
r1, _, err := procLoadIconMetric.Call(
	uintptr(hinst),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszName))),
	uintptr(lims),
	uintptr(phico),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function LoadIconMetric(
  hinst: THandle;   // HINSTANCE optional
  pszName: PWideChar;   // LPCWSTR
  lims: Integer;   // _LI_METRIC
  phico: Pointer   // HICON* out
): Integer; stdcall;
  external 'COMCTL32.dll' name 'LoadIconMetric';
result := DllCall("COMCTL32\LoadIconMetric"
    , "Ptr", hinst   ; HINSTANCE optional
    , "WStr", pszName   ; LPCWSTR
    , "Int", lims   ; _LI_METRIC
    , "Ptr", phico   ; HICON* out
    , "Int")   ; return: HRESULT
●LoadIconMetric(hinst, pszName, lims, phico) = DLL("COMCTL32.dll", "int LoadIconMetric(void*, char*, int, void*)")
# 呼び出し: LoadIconMetric(hinst, pszName, lims, phico)
# hinst : HINSTANCE optional -> "void*"
# pszName : LPCWSTR -> "char*"
# lims : _LI_METRIC -> "int"
# phico : HICON* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "comctl32" fn LoadIconMetric(
    hinst: ?*anyopaque, // HINSTANCE optional
    pszName: [*c]const u16, // LPCWSTR
    lims: i32, // _LI_METRIC
    phico: ?*anyopaque // HICON* out
) callconv(std.os.windows.WINAPI) i32;
proc LoadIconMetric(
    hinst: pointer,  # HINSTANCE optional
    pszName: WideCString,  # LPCWSTR
    lims: int32,  # _LI_METRIC
    phico: pointer  # HICON* out
): int32 {.importc: "LoadIconMetric", stdcall, dynlib: "COMCTL32.dll".}
pragma(lib, "comctl32");
extern(Windows)
int LoadIconMetric(
    void* hinst,   // HINSTANCE optional
    const(wchar)* pszName,   // LPCWSTR
    int lims,   // _LI_METRIC
    void* phico   // HICON* out
);
ccall((:LoadIconMetric, "COMCTL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Int32, Ptr{Cvoid}),
      hinst, pszName, lims, phico)
# hinst : HINSTANCE optional -> Ptr{Cvoid}
# pszName : LPCWSTR -> Cwstring
# lims : _LI_METRIC -> Int32
# phico : HICON* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t LoadIconMetric(
    void* hinst,
    const uint16_t* pszName,
    int32_t lims,
    void* phico);
]]
local comctl32 = ffi.load("comctl32")
-- comctl32.LoadIconMetric(hinst, pszName, lims, phico)
-- hinst : HINSTANCE optional
-- pszName : LPCWSTR
-- lims : _LI_METRIC
-- phico : HICON* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('COMCTL32.dll');
const LoadIconMetric = lib.func('__stdcall', 'LoadIconMetric', 'int32_t', ['void *', 'str16', 'int32_t', 'void *']);
// LoadIconMetric(hinst, pszName, lims, phico)
// hinst : HINSTANCE optional -> 'void *'
// pszName : LPCWSTR -> 'str16'
// lims : _LI_METRIC -> 'int32_t'
// phico : HICON* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("COMCTL32.dll", {
  LoadIconMetric: { parameters: ["pointer", "buffer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.LoadIconMetric(hinst, pszName, lims, phico)
// hinst : HINSTANCE optional -> "pointer"
// pszName : LPCWSTR -> "buffer"
// lims : _LI_METRIC -> "i32"
// phico : HICON* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t LoadIconMetric(
    void* hinst,
    const uint16_t* pszName,
    int32_t lims,
    void* phico);
C, "COMCTL32.dll");
// $ffi->LoadIconMetric(hinst, pszName, lims, phico);
// hinst : HINSTANCE optional
// pszName : LPCWSTR
// lims : _LI_METRIC
// phico : HICON* out
// 構造体/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 Comctl32 extends StdCallLibrary {
    Comctl32 INSTANCE = Native.load("comctl32", Comctl32.class);
    int LoadIconMetric(
        Pointer hinst,   // HINSTANCE optional
        WString pszName,   // LPCWSTR
        int lims,   // _LI_METRIC
        Pointer phico   // HICON* out
    );
}
@[Link("comctl32")]
lib LibCOMCTL32
  fun LoadIconMetric = LoadIconMetric(
    hinst : Void*,   # HINSTANCE optional
    pszName : UInt16*,   # LPCWSTR
    lims : Int32,   # _LI_METRIC
    phico : Void*   # HICON* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LoadIconMetricNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int32, Pointer<Void>);
typedef LoadIconMetricDart = int Function(Pointer<Void>, Pointer<Utf16>, int, Pointer<Void>);
final LoadIconMetric = DynamicLibrary.open('COMCTL32.dll')
    .lookupFunction<LoadIconMetricNative, LoadIconMetricDart>('LoadIconMetric');
// hinst : HINSTANCE optional -> Pointer<Void>
// pszName : LPCWSTR -> Pointer<Utf16>
// lims : _LI_METRIC -> Int32
// phico : HICON* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadIconMetric(
  hinst: THandle;   // HINSTANCE optional
  pszName: PWideChar;   // LPCWSTR
  lims: Integer;   // _LI_METRIC
  phico: Pointer   // HICON* out
): Integer; stdcall;
  external 'COMCTL32.dll' name 'LoadIconMetric';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LoadIconMetric"
  c_LoadIconMetric :: Ptr () -> CWString -> Int32 -> Ptr () -> IO Int32
-- hinst : HINSTANCE optional -> Ptr ()
-- pszName : LPCWSTR -> CWString
-- lims : _LI_METRIC -> Int32
-- phico : HICON* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let loadiconmetric =
  foreign "LoadIconMetric"
    ((ptr void) @-> (ptr uint16_t) @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hinst : HINSTANCE optional -> (ptr void) *)
(* pszName : LPCWSTR -> (ptr uint16_t) *)
(* lims : _LI_METRIC -> int32_t *)
(* phico : HICON* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library comctl32 (t "COMCTL32.dll"))
(cffi:use-foreign-library comctl32)

(cffi:defcfun ("LoadIconMetric" load-icon-metric :convention :stdcall) :int32
  (hinst :pointer)   ; HINSTANCE optional
  (psz-name (:string :encoding :utf-16le))   ; LPCWSTR
  (lims :int32)   ; _LI_METRIC
  (phico :pointer))   ; HICON* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadIconMetric = Win32::API::More->new('COMCTL32',
    'int LoadIconMetric(HANDLE hinst, LPCWSTR pszName, int lims, HANDLE phico)');
# my $ret = $LoadIconMetric->Call($hinst, $pszName, $lims, $phico);
# hinst : HINSTANCE optional -> HANDLE
# pszName : LPCWSTR -> LPCWSTR
# lims : _LI_METRIC -> int
# phico : HICON* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型