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

LoadIconA

関数
アイコンリソースを読み込みハンドルを返す(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USER32.dll  (ANSI / -A)
#include <windows.h>

HICON LoadIconA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpIconName
);

パラメーター

名前方向説明
hInstanceHINSTANCEinoptional

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

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

lpIconNameLPCSTRin

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

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

戻り値の型: HICON

公式ドキュメント

アプリケーションインスタンスに関連付けられた実行可能ファイル (.exe) から、指定したアイコンリソースを読み込みます。(ANSI)

戻り値

型: HICON

関数が成功した場合、戻り値は新しく読み込まれたアイコンへのハンドルです。

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

解説(Remarks)

LoadIcon は、アイコンリソースがまだ読み込まれていない場合にのみ読み込みます。それ以外の場合は、既存のリソースへのハンドルを取得します。この関数は、現在のディスプレイに最も適したアイコンをアイコンリソースから検索します。アイコンリソースはカラーまたはモノクロのビットマップです。

LoadIcon は、サイズが SM_CXICON および SM_CYICON システムメトリック値に一致するアイコンのみを読み込むことができます。他のサイズのアイコンを読み込むには、LoadImage 関数を使用してください。

メモ

winuser.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして LoadIcon を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// USER32.dll  (ANSI / -A)
#include <windows.h>

HICON LoadIconA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpIconName
);
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern IntPtr LoadIconA(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPStr)] string lpIconName   // LPCSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadIconA(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPStr)> lpIconName As String   ' LPCSTR
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpIconName : LPCSTR
Declare PtrSafe Function LoadIconA Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpIconName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LoadIconA = ctypes.windll.user32.LoadIconA
LoadIconA.restype = ctypes.c_void_p
LoadIconA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpIconName : LPCSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadIconA = Fiddle::Function.new(
  lib['LoadIconA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpIconName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn LoadIconA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpIconName: *const u8  // LPCSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern IntPtr LoadIconA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpIconName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadIconA' -Namespace Win32 -PassThru
# $api::LoadIconA(hInstance, lpIconName)
#uselib "USER32.dll"
#func global LoadIconA "LoadIconA" sptr, sptr
; LoadIconA hInstance, lpIconName   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "sptr"
; lpIconName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadIconA "LoadIconA" sptr, str
; res = LoadIconA(hInstance, lpIconName)
; hInstance : HINSTANCE optional -> "sptr"
; lpIconName : LPCSTR -> "str"
; HICON LoadIconA(HINSTANCE hInstance, LPCSTR lpIconName)
#uselib "USER32.dll"
#cfunc global LoadIconA "LoadIconA" intptr, str
; res = LoadIconA(hInstance, lpIconName)
; hInstance : HINSTANCE optional -> "intptr"
; lpIconName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadIconA = user32.NewProc("LoadIconA")
)

// hInstance (HINSTANCE optional), lpIconName (LPCSTR)
r1, _, err := procLoadIconA.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpIconName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HICON
function LoadIconA(
  hInstance: THandle;   // HINSTANCE optional
  lpIconName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadIconA';
result := DllCall("USER32\LoadIconA"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "AStr", lpIconName   ; LPCSTR
    , "Ptr")   ; return: HICON
●LoadIconA(hInstance, lpIconName) = DLL("USER32.dll", "void* LoadIconA(void*, char*)")
# 呼び出し: LoadIconA(hInstance, lpIconName)
# hInstance : HINSTANCE optional -> "void*"
# lpIconName : LPCSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "user32" fn LoadIconA(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpIconName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LoadIconA(
    hInstance: pointer,  # HINSTANCE optional
    lpIconName: cstring  # LPCSTR
): pointer {.importc: "LoadIconA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* LoadIconA(
    void* hInstance,   // HINSTANCE optional
    const(char)* lpIconName   // LPCSTR
);
ccall((:LoadIconA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring),
      hInstance, lpIconName)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpIconName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LoadIconA(
    void* hInstance,
    const char* lpIconName);
]]
local user32 = ffi.load("user32")
-- user32.LoadIconA(hInstance, lpIconName)
-- hInstance : HINSTANCE optional
-- lpIconName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadIconA = lib.func('__stdcall', 'LoadIconA', 'void *', ['void *', 'str']);
// LoadIconA(hInstance, lpIconName)
// hInstance : HINSTANCE optional -> 'void *'
// lpIconName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadIconA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.LoadIconA(hInstance, lpIconName)
// hInstance : HINSTANCE optional -> "pointer"
// lpIconName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadIconA(
    void* hInstance,
    const char* lpIconName);
C, "USER32.dll");
// $ffi->LoadIconA(hInstance, lpIconName);
// hInstance : HINSTANCE optional
// lpIconName : LPCSTR
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    Pointer LoadIconA(
        Pointer hInstance,   // HINSTANCE optional
        String lpIconName   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun LoadIconA = LoadIconA(
    hInstance : Void*,   # HINSTANCE optional
    lpIconName : UInt8*   # LPCSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef LoadIconANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
typedef LoadIconADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
final LoadIconA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadIconANative, LoadIconADart>('LoadIconA');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpIconName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadIconA(
  hInstance: THandle;   // HINSTANCE optional
  lpIconName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadIconA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LoadIconA"
  c_LoadIconA :: Ptr () -> CString -> IO (Ptr ())
-- hInstance : HINSTANCE optional -> Ptr ()
-- lpIconName : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let loadicona =
  foreign "LoadIconA"
    ((ptr void) @-> string @-> returning (ptr void))
(* hInstance : HINSTANCE optional -> (ptr void) *)
(* lpIconName : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library user32 (t "USER32.dll"))
(cffi:use-foreign-library user32)

(cffi:defcfun ("LoadIconA" load-icon-a :convention :stdcall) :pointer
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-icon-name :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadIconA = Win32::API::More->new('USER32',
    'HANDLE LoadIconA(HANDLE hInstance, LPCSTR lpIconName)');
# my $ret = $LoadIconA->Call($hInstance, $lpIconName);
# hInstance : HINSTANCE optional -> HANDLE
# lpIconName : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目