LoadBitmapA 関数 (winuser.h)

[アーティクル]
03/13/2024

[LoadBitmap は、[要件] セクションで指定したオペレーティングシステムで使用できます。今後のバージョンでは変更されるか、利用できなくなる場合もあります。代わりに、 LoadImage と DrawFrameControl を使用します。

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

構文

HBITMAP LoadBitmapA(
  [in] HINSTANCE hInstance,
  [in] LPCSTR    lpBitmapName
);

パラメーター

[in] hInstance

読み込まれるビットマップが実行可能ファイルに含まれているモジュールのインスタンスへのハンドル。

[in] lpBitmapName

読み込まれるビットマップリソースの名前を含む null で終わる文字列へのポインター。または、このパラメーターは、下位ワードのリソース識別子と、上位ワードの 0 で構成できます。 MAKEINTRESOURCE マクロを使用して、この値を作成できます。

戻り値

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

関数が失敗した場合は、返される値は NULL です。

注釈

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 を定義する必要があります。

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

例

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

注意

winuser.h ヘッダーは、LoadBitmap をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll
API セット	ext-ms-win-ntuser-draw-l1-1-1 (Windows 8.1 で導入)