ImageList_SetOverlayImage 関数 (commctrl.h)

  • [アーティクル]

オーバーレイ マスクとして使用するイメージの一覧に、指定したイメージを追加します。 イメージ リストには、バージョン 4.70 以前では最大 4 つのオーバーレイ マスク、バージョン 4.71 では最大 15 個のオーバーレイ マスクを使用できます。 関数は、指定されたイメージにオーバーレイ マスク インデックスを割り当てます。

構文

BOOL ImageList_SetOverlayImage(
  [in] HIMAGELIST himl,
  [in] int        iImage,
  [in] int        iOverlay
);

パラメーター

[in] himl

種類: HIMAGELIST

イメージ リストへのハンドル。

[in] iImage

型: int

himl イメージ リスト内のイメージの 0 から始まるインデックス。 このインデックスは、オーバーレイ マスクとして使用するイメージを識別します。

[in] iOverlay

型: int

オーバーレイ マスクの 1 から始まるインデックス。

戻り値

種類: BOOL

成功した場合は 0 以外、それ以外の場合は 0 を返します。

注釈

オーバーレイ マスクは、別のイメージの上に透明に描画されるイメージです。 イメージ上にオーバーレイ マスクを描画するには、ImageList_Draw または ImageList_DrawEx 関数 を 呼び出します。 これらの関数の fStyle パラメーターは 、INDEXTOOVERLAYMASK マクロを使用してオーバーレイ マスク インデックスを指定できます。

イメージ リストがマスクを使用して作成されない限り、このメソッドの呼び出しは失敗し、E_INVALIDARGを返します。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー commctrl.h
Library Comctl32.lib
[DLL] Comctl32.dll
API セット ext-ms-win-shell-comctl32-init-l1-1-1 (Windows 10 バージョン 10.0.14393 で導入)