SHGetIconOverlayIndexA 関数 (shlobj_core.h)

[アーティクル]
11/20/2024

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

構文

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

パラメーター

[in, optional] pszIconPath

型: LPCTSTR

アイコンを含むファイルの完全修飾パスを含む最大長 MAX_PATH の null で終わる文字列へのポインター。

iIconIndex

型: int

pszIconPathによって指ファイル内のアイコンのインデックス。標準のオーバーレイアイコンを要求するには、pszIconPath NULLをに設定し、iIconIndex を次のいずれかにします。

IDO_SHGIOI_SHARE (0x0FFFFFFF)

共有フォルダーを示すオーバーレイアイコン。

IDO_SHGIOI_LINK (0x0FFFFFFE)

リンクされたフォルダーまたはファイルを示すオーバーレイアイコン。

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

低速ファイルを示すオーバーレイアイコン。

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 以降のをします。アイテムがセット内の既定値であることを示すオーバーレイアイコン。 1 つの例として、既定のプリンターがあります。

戻り値

型: int

成功した場合はシステムイメージリストのオーバーレイアイコンのインデックスを返し、それ以外の場合は -1 返します。

備考

アイコンオーバーレイは、システムイメージリストの一部です。 2 つの識別子があります。 1 つ目は 1 から始まるオーバーレイインデックスで、イメージリスト内の他のオーバーレイを基準にオーバーレイを識別します。もう 1 つは、実際のイメージを識別するイメージインデックスです。これら 2 つのインデックスは、ImageList_SetOverlayImageを持つプライベートイメージリストにアイコンオーバーレイを追加するときに、それぞれ iOverlay および iImage パラメーターに割り当てる値と同じです。 SHGetIconOverlayIndex オーバーレイインデックスを返します。オーバーレイインデックスを同等のイメージインデックスに変換するには、INDEXTOOVERLAYMASK呼び出します。

注初期化中にイメージがシステムイメージリストに読み込まれた後は、変更できません。 pszIconPath と iIconIndex で指定ファイル名とインデックスは、アイコンオーバーレイを識別するためにのみ使用されます。 SHGetIconOverlayIndex を使用してシステムイメージリストを変更することはできません。

手記

shlobj_core.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHGetIconOverlayIndex を定義します。エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイムエラーが発生する不一致が発生する可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

必要条件

要件	価値
サポートされる最小クライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	shlobj_core.h (Shlobj.h、Shlobj_core.h を含む)
ライブラリ	Shell32.lib
DLL	Shell32.dll (バージョン 5.0 以降)

次の方法で共有