Win32 API 日本語リファレンス
ホームGraphics.Gdi › LoadBitmapA

LoadBitmapA

関数
リソースからビットマップを読み込む(ANSI版)。
DLLUSER32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HBITMAP LoadBitmapA(
    HINSTANCE hInstance,   // optional
    LPCSTR lpBitmapName
);

パラメーター

名前方向説明
hInstanceHINSTANCEinoptional読み込むビットマップを含む実行可能ファイルを持つモジュールのインスタンスへのハンドル。
lpBitmapNameLPCSTRin読み込むビットマップリソースの名前を含む、null 終端文字列へのポインター。あるいは、このパラメーターは下位ワードにリソース識別子を、上位ワードに 0 を指定する形でも構いません。この値の作成には MAKEINTRESOURCE マクロを使用できます。

戻り値の型: HBITMAP

公式ドキュメント

LoadBitmap 関数は、指定したビットマップリソースをモジュールの実行可能ファイルから読み込みます。(ANSI)

戻り値

関数が成功した場合、戻り値は指定したビットマップへのハンドルです。

関数が失敗した場合、戻り値は NULL です。

解説(Remarks)

lpBitmapName パラメーターが指すビットマップが存在しない場合、またはビットマップを読み込むためのメモリが不足している場合、関数は失敗します。

LoadBitmap はディスプレイと互換性のあるビットマップを作成しますが、これはプリンターに選択できません。プリンターに選択できるビットマップを読み込むには、LoadImage を呼び出し、LR_CREATEDIBSECTION を指定して DIB セクションを作成します。DIB セクションは任意のデバイスに選択できます。

アプリケーションは LoadBitmap 関数を使用して、定義済みビットマップにアクセスできます。そのためには、hInstance パラメーターを NULL に、lpBitmapName パラメーターを次のいずれかの値に設定する必要があります。

ビットマップ名 ビットマップ名
OBM_BTNCORNERS OBM_OLD_RESTORE
OBM_BTSIZE OBM_OLD_RGARROW
OBM_CHECK OBM_OLD_UPARROW
OBM_CHECKBOXES OBM_OLD_ZOOM
OBM_CLOSE OBM_REDUCE
OBM_COMBO OBM_REDUCED
OBM_DNARROW OBM_RESTORE
OBM_DNARROWD OBM_RESTORED
OBM_DNARROWI OBM_RGARROW
OBM_LFARROW OBM_RGARROWD
OBM_LFARROWD OBM_RGARROWI
OBM_LFARROWI OBM_SIZE
OBM_MNARROW OBM_UPARROW
OBM_OLD_CLOSE OBM_UPARROWD
OBM_OLD_DNARROW OBM_UPARROWI
OBM_OLD_LFARROW OBM_ZOOM
OBM_OLD_REDUCE OBM_ZOOMD

OBM_OLD で始まるビットマップ名は、3.0 より前の 16 ビット版 Windows で使用されていたビットマップを表します。

アプリケーションが OBM_ 定数のいずれかを使用するには、Windows.h ヘッダーファイルをインクルードする前に定数 OEMRESOURCE が定義されている必要があります。

アプリケーションは、LoadBitmap 関数が返した各ビットマップハンドルを削除するために DeleteObject 関数を呼び出す必要があります。

例については、メニューの使用の「メニュー項目ビットマップの例」を参照してください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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>

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

LoadBitmapA = ctypes.windll.user32.LoadBitmapA
LoadBitmapA.restype = ctypes.c_void_p
LoadBitmapA.argtypes = [
    wintypes.HANDLE,  # hInstance : HINSTANCE optional
    wintypes.LPCSTR,  # lpBitmapName : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USER32.dll')
LoadBitmapA = Fiddle::Function.new(
  lib['LoadBitmapA'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpBitmapName : LPCSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "user32")]
extern "system" {
    fn LoadBitmapA(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpBitmapName: *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)]
public static extern IntPtr LoadBitmapA(IntPtr hInstance, [MarshalAs(UnmanagedType.LPStr)] string lpBitmapName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadBitmapA' -Namespace Win32 -PassThru
# $api::LoadBitmapA(hInstance, lpBitmapName)
#uselib "USER32.dll"
#func global LoadBitmapA "LoadBitmapA" sptr, sptr
; LoadBitmapA hInstance, lpBitmapName   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "sptr"
; lpBitmapName : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadBitmapA "LoadBitmapA" sptr, str
; res = LoadBitmapA(hInstance, lpBitmapName)
; hInstance : HINSTANCE optional -> "sptr"
; lpBitmapName : LPCSTR -> "str"
; HBITMAP LoadBitmapA(HINSTANCE hInstance, LPCSTR lpBitmapName)
#uselib "USER32.dll"
#cfunc global LoadBitmapA "LoadBitmapA" intptr, str
; res = LoadBitmapA(hInstance, lpBitmapName)
; hInstance : HINSTANCE optional -> "intptr"
; lpBitmapName : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadBitmapA = user32.NewProc("LoadBitmapA")
)

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

extern "user32" fn LoadBitmapA(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpBitmapName: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc LoadBitmapA(
    hInstance: pointer,  # HINSTANCE optional
    lpBitmapName: cstring  # LPCSTR
): pointer {.importc: "LoadBitmapA", stdcall, dynlib: "USER32.dll".}
pragma(lib, "user32");
extern(Windows)
void* LoadBitmapA(
    void* hInstance,   // HINSTANCE optional
    const(char)* lpBitmapName   // LPCSTR
);
ccall((:LoadBitmapA, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cstring),
      hInstance, lpBitmapName)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpBitmapName : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* LoadBitmapA(
    void* hInstance,
    const char* lpBitmapName);
]]
local user32 = ffi.load("user32")
-- user32.LoadBitmapA(hInstance, lpBitmapName)
-- hInstance : HINSTANCE optional
-- lpBitmapName : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadBitmapA = lib.func('__stdcall', 'LoadBitmapA', 'void *', ['void *', 'str']);
// LoadBitmapA(hInstance, lpBitmapName)
// hInstance : HINSTANCE optional -> 'void *'
// lpBitmapName : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadBitmapA: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.LoadBitmapA(hInstance, lpBitmapName)
// hInstance : HINSTANCE optional -> "pointer"
// lpBitmapName : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadBitmapA(
    void* hInstance,
    const char* lpBitmapName);
C, "USER32.dll");
// $ffi->LoadBitmapA(hInstance, lpBitmapName);
// hInstance : HINSTANCE optional
// lpBitmapName : 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 LoadBitmapA(
        Pointer hInstance,   // HINSTANCE optional
        String lpBitmapName   // LPCSTR
    );
}
@[Link("user32")]
lib LibUSER32
  fun LoadBitmapA = LoadBitmapA(
    hInstance : Void*,   # HINSTANCE optional
    lpBitmapName : 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 LoadBitmapANative = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
typedef LoadBitmapADart = Pointer<Void> Function(Pointer<Void>, Pointer<Utf8>);
final LoadBitmapA = DynamicLibrary.open('USER32.dll')
    .lookupFunction<LoadBitmapANative, LoadBitmapADart>('LoadBitmapA');
// hInstance : HINSTANCE optional -> Pointer<Void>
// lpBitmapName : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadBitmapA(
  hInstance: THandle;   // HINSTANCE optional
  lpBitmapName: PAnsiChar   // LPCSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadBitmapA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

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

関連項目

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