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

LoadBitmapW

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

シグネチャ

// USER32.dll  (Unicode / -W)
#include <windows.h>

HBITMAP LoadBitmapW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpBitmapName
);

パラメーター

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

戻り値の型: HBITMAP

公式ドキュメント

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

戻り値

関数が成功すると、戻り値は指定されたビットマップへのハンドルです。

関数が失敗すると、戻り値は 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 関数を呼び出す必要があります。

例については、Using Menus の「Example of Menu-Item Bitmaps」を参照してください。

メモ

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

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

各言語での呼び出し定義

// USER32.dll  (Unicode / -W)
#include <windows.h>

HBITMAP LoadBitmapW(
    HINSTANCE hInstance,   // optional
    LPCWSTR lpBitmapName
);
[DllImport("USER32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr LoadBitmapW(
    IntPtr hInstance,   // HINSTANCE optional
    [MarshalAs(UnmanagedType.LPWStr)] string lpBitmapName   // LPCWSTR
);
<DllImport("USER32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function LoadBitmapW(
    hInstance As IntPtr,   ' HINSTANCE optional
    <MarshalAs(UnmanagedType.LPWStr)> lpBitmapName As String   ' LPCWSTR
) As IntPtr
End Function
' hInstance : HINSTANCE optional
' lpBitmapName : LPCWSTR
Declare PtrSafe Function LoadBitmapW Lib "user32" ( _
    ByVal hInstance As LongPtr, _
    ByVal lpBitmapName As LongPtr) As LongPtr
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

lib = Fiddle.dlopen('USER32.dll')
LoadBitmapW = Fiddle::Function.new(
  lib['LoadBitmapW'],
  [
    Fiddle::TYPE_VOIDP,  # hInstance : HINSTANCE optional
    Fiddle::TYPE_VOIDP,  # lpBitmapName : LPCWSTR
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "user32")]
extern "system" {
    fn LoadBitmapW(
        hInstance: *mut core::ffi::c_void,  // HINSTANCE optional
        lpBitmapName: *const u16  // LPCWSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("USER32.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr LoadBitmapW(IntPtr hInstance, [MarshalAs(UnmanagedType.LPWStr)] string lpBitmapName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USER32_LoadBitmapW' -Namespace Win32 -PassThru
# $api::LoadBitmapW(hInstance, lpBitmapName)
#uselib "USER32.dll"
#func global LoadBitmapW "LoadBitmapW" wptr, wptr
; LoadBitmapW hInstance, lpBitmapName   ; 戻り値は stat
; hInstance : HINSTANCE optional -> "wptr"
; lpBitmapName : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USER32.dll"
#cfunc global LoadBitmapW "LoadBitmapW" sptr, wstr
; res = LoadBitmapW(hInstance, lpBitmapName)
; hInstance : HINSTANCE optional -> "sptr"
; lpBitmapName : LPCWSTR -> "wstr"
; HBITMAP LoadBitmapW(HINSTANCE hInstance, LPCWSTR lpBitmapName)
#uselib "USER32.dll"
#cfunc global LoadBitmapW "LoadBitmapW" intptr, wstr
; res = LoadBitmapW(hInstance, lpBitmapName)
; hInstance : HINSTANCE optional -> "intptr"
; lpBitmapName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	user32 = windows.NewLazySystemDLL("USER32.dll")
	procLoadBitmapW = user32.NewProc("LoadBitmapW")
)

// hInstance (HINSTANCE optional), lpBitmapName (LPCWSTR)
r1, _, err := procLoadBitmapW.Call(
	uintptr(hInstance),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpBitmapName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HBITMAP
function LoadBitmapW(
  hInstance: THandle;   // HINSTANCE optional
  lpBitmapName: PWideChar   // LPCWSTR
): THandle; stdcall;
  external 'USER32.dll' name 'LoadBitmapW';
result := DllCall("USER32\LoadBitmapW"
    , "Ptr", hInstance   ; HINSTANCE optional
    , "WStr", lpBitmapName   ; LPCWSTR
    , "Ptr")   ; return: HBITMAP
●LoadBitmapW(hInstance, lpBitmapName) = DLL("USER32.dll", "void* LoadBitmapW(void*, char*)")
# 呼び出し: LoadBitmapW(hInstance, lpBitmapName)
# hInstance : HINSTANCE optional -> "void*"
# lpBitmapName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "user32" fn LoadBitmapW(
    hInstance: ?*anyopaque, // HINSTANCE optional
    lpBitmapName: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc LoadBitmapW(
    hInstance: pointer,  # HINSTANCE optional
    lpBitmapName: WideCString  # LPCWSTR
): pointer {.importc: "LoadBitmapW", stdcall, dynlib: "USER32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "user32");
extern(Windows)
void* LoadBitmapW(
    void* hInstance,   // HINSTANCE optional
    const(wchar)* lpBitmapName   // LPCWSTR
);
ccall((:LoadBitmapW, "USER32.dll"), stdcall, Ptr{Cvoid},
      (Ptr{Cvoid}, Cwstring),
      hInstance, lpBitmapName)
# hInstance : HINSTANCE optional -> Ptr{Cvoid}
# lpBitmapName : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* LoadBitmapW(
    void* hInstance,
    const uint16_t* lpBitmapName);
]]
local user32 = ffi.load("user32")
-- user32.LoadBitmapW(hInstance, lpBitmapName)
-- hInstance : HINSTANCE optional
-- lpBitmapName : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('USER32.dll');
const LoadBitmapW = lib.func('__stdcall', 'LoadBitmapW', 'void *', ['void *', 'str16']);
// LoadBitmapW(hInstance, lpBitmapName)
// hInstance : HINSTANCE optional -> 'void *'
// lpBitmapName : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USER32.dll", {
  LoadBitmapW: { parameters: ["pointer", "buffer"], result: "pointer" },
});
// lib.symbols.LoadBitmapW(hInstance, lpBitmapName)
// hInstance : HINSTANCE optional -> "pointer"
// lpBitmapName : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* LoadBitmapW(
    void* hInstance,
    const uint16_t* lpBitmapName);
C, "USER32.dll");
// $ffi->LoadBitmapW(hInstance, lpBitmapName);
// hInstance : HINSTANCE optional
// lpBitmapName : LPCWSTR
// 構造体/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.UNICODE_OPTIONS);
    Pointer LoadBitmapW(
        Pointer hInstance,   // HINSTANCE optional
        WString lpBitmapName   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("user32")]
lib LibUSER32
  fun LoadBitmapW = LoadBitmapW(
    hInstance : Void*,   # HINSTANCE optional
    lpBitmapName : UInt16*   # LPCWSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

(cffi:defcfun ("LoadBitmapW" load-bitmap-w :convention :stdcall) :pointer
  (h-instance :pointer)   ; HINSTANCE optional
  (lp-bitmap-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadBitmapW = Win32::API::More->new('USER32',
    'HANDLE LoadBitmapW(HANDLE hInstance, LPCWSTR lpBitmapName)');
# my $ret = $LoadBitmapW->Call($hInstance, $lpBitmapName);
# hInstance : HINSTANCE optional -> HANDLE
# lpBitmapName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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