Win32API: LoadImage

指定したイメージを読み込みます。


定義
Declare Function LoadImage Lib "user32" Alias "LoadImageA" _
   (hInst As HINSTANCE, _
    lpszName As BytePtr, _
    dwImageType As DWord, _
    cxDesired As Long, _
    cyDesired As Long, _
    dwFlags As DWord) As HANDLE
hInst
ロードするイメージが入ったモジュールのインスタンスのハンドルを指定します。

lpszName
ロードするイメージの名前を指定します。
dwFlags パラメータに LR_LOADFROMFILE フラグが設定されているときは、イメージ ファイルへのパスが格納されている文字列へのポインタを指定します。

dwImageType
ロードするイメージのタイプを、以下の定数から指定します。
定数説明
IMAGE_BITMAPビットマップ
IMAGE_CURSORマウス カーソル
IMAGE_ICONアイコン

cxDesired
ロードするイメージの幅を指定します。

cyDesired
ロードするイメージの高さを指定します。

dwFlags
オプション フラグを、以下の定数を組み合わせて指定します。
定数説明
LR_DEFAULTCOLORデフォルトです。
LR_CREATEDIBSECTIONコンパチブル ビットマップではなく、DIB セクション ビットマップを戻り値にします(dwImageType パラメータに IMAGE_BITMAP が設定されているときのみ)。
LR_DEFAULTSIZEcxDesired パラメータおよび cyDesired パラメータに 0 を指定すると、デフォルトのサイズで読み込むようにします。
LR_LOADFROMFILElpszName パラメータがイメージ ファイルへのパスを示すことを意味します。
LR_LOADMAP3DCOLORSイメージ内の以下の灰色部分を、対応する 3D カラーに置き換えます。
LR_LOADTRANSPARENTイメージ内の最初のピクセルの色を取得し、カラー テーブル内の対応するエントリをデフォルト ウィンドウ カラー(COLOR_WINDOW)に置き換えます。
LR_MONOCHROMEイメージをモノクロで読み込みます。
LR_SHAREDイメージ ハンドルを共有することを意味します。このフラグで取得したオブジェクトは、アプリケーション終了時に、システムが解放を行います。

戻り値

関数が成功すると、イメージ オブジェクトのハンドルが返ります。失敗すると、0 が返ります。

解説

取得したオブジェクトが不要になったときは、対応する以下の関数でメモリから解放する必要があります。ただし、dwFlags パラメータに LR_SHARED フラグを設定したときは、解放する必要はありません(システムが自動的に解放します)。
オブジェクト関数
ビットマップDeleteObject関数
マウス カーソルDestroyCursor関数
アイコンDestroyIcon関数

環境情報

インクルード ファイル: api_window.sbp 内で定義済み
DLLファイル: user32.dll


CopyImage関数LoadBitmap関数LoadIcon関数