IImageList::SetOverlayImage メソッド (commoncontrols.h)

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

構文

HRESULT SetOverlayImage(
  [in] int iImage,
  [in] int iOverlay
);

パラメーター

[in] iImage

型: int

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

[in] iOverlay

型: int

オーバーレイ マスクの 1 から始まるインデックスを含む int 型の値。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

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

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

IImageList::SetOverlayImage を使用するには、マニフェスト Comctl32.dll バージョン 6 を指定します。 マニフェストの詳細については、「 ビジュアル スタイルの有効化」を参照してください。

要件