IShellIconOverlayIdentifier::GetOverlayInfo メソッド (shobjidl_core.h)

アイコン オーバーレイのビットマップの場所を提供します。

構文

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

パラメーター

[out] pwszIconFile

種類: PWSTR

アイコンを含むファイルの完全修飾パスを含む null で終わる Unicode 文字列。 .dll、.exe、.ico のファイルの種類はすべて許容されます。 ファイル名を返す場合は、pdwFlags で ISIOI_ICONFILE フラグを設定する必要があります。

cchMax

型: int

pwszIconFile バッファーのサイズ (Unicode 文字)。

[out] pIndex

型: int*

複数のアイコンを含むファイル内のアイコンを識別するために使用されるインデックス値へのポインター。 インデックスを返す場合は、pdwFlags で ISIOI_ICONINDEX フラグを設定する必要があります。

[out] pdwFlags

型: DWORD*

メソッドによって返される情報を指定するビットマップへのポインター。 このパラメーターには、次の値のいずれかまたは両方を指定できます。

ISIOI_ICONFILE (0x00000001)

アイコン ファイルのパスは pwszIconFile を介して返されます。

ISIOI_ICONINDEX (0x00000002)

pwszIconFile には複数のアイコンがあります。 アイコンのインデックスは pIndex から返されます。

戻り値

型: HRESULT

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

解説

このメソッドは、ハンドラーのアイコン オーバーレイをシステム イメージ の一覧に追加できるように、起動時にシェルによって呼び出されます。 初期化が完了すると、ハンドラーのアイコン オーバーレイを表示する必要があるときに、シェルは GetOverlayInfo を呼び出します。

メモ 初期化中にイメージがシステム イメージ リストに読み込まれた後は、変更できません。 初期化後、ファイル名とインデックスはアイコン オーバーレイを識別するためにのみ使用されます。 新しいアイコン オーバーレイは読み込まれません。 GetOverlayInfo が呼び出されると、ハンドラーは、関数が最初に呼び出されたときに指定されたのと同じファイル名とインデックスを返す必要があります。

 

要件

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