IShellIconOverlay::GetOverlayIconIndex メソッド (shlobj_core.h)

  • [アーティクル]

システム イメージ リスト内のアイコン オーバーレイのインデックスを取得します。

構文

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

パラメーター

[in] pidl

種類: PCUITEMID_CHILD

アイコンが表示されているオブジェクトを識別する ITEMIDLIST 構造体へのポインター。

[in, out] pIconIndex

型: int*

システム イメージ リスト内のアイコン オーバーレイのイメージのインデックスへのポインター。 このインデックスは、ImageList::SetOverlayImage 関数を使用してプライベート イメージ リストにオーバーレイ イメージを追加するときに指定される iImage 値と同じです。

戻り値

種類: HRESULT

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード 説明
S_OK
 オーバーレイのインデックスが見つかりました。
S_FALSE
 このファイルにはオーバーレイは存在しません。
E_FAIL
 PIDL が無効です。

注釈

システム イメージ リストでオーバーレイのイメージ インデックスを取得するには、まず SHGetIconOverlayIndex を呼び出してオーバーレイ インデックスを取得する必要があります。 次に 、INDEXTOOVERLAYMASK マクロを使用して、オーバーレイ インデックスを同等のイメージ インデックスに変換します。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー shlobj_core.h
[DLL] Shell32.dll (バージョン 5.0 以降)

こちらもご覧ください

IShellIconOverlay