SHGetIconOverlayIndexW

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

SHGetIconOverlayIndexW pszIconPath, iIconIndex

pszIconPath : [wstr] 型: LPCTSTR アイコンを含むファイルの完全修飾パスを格納する、最大長 MAX_PATH の null 終端文字列へのポインター。
iIconIndex : [int] 型: int pszIconPath が指すファイル内のアイコンのインデックス。標準オーバーレイアイコンを要求するには、pszIconPath を NULL に設定し、iIconIndex を次のいずれかに設定する。

(プラグイン / モジュール : shell32.dll)

解説

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

[戻り値]
型: int 成功した場合はシステムイメージリスト内のオーバーレイアイコンのインデックスを返す。失敗した場合は -1 を返す。

[備考]
アイコンオーバーレイはシステムイメージリストの一部である。これらには 2 つの識別子がある。1
つ目は、イメージリスト内の他のオーバーレイに対するオーバーレイを識別する 1 から始まるオーバーレイインデックスである。もう 1
つは、実際のイメージを識別するイメージインデックスである。これら 2
つのインデックスは、ImageList_SetOverlayImage でプライベートイメージリストにアイコンオーバーレイを追加する際に
iOverlay および iImage パラメーターにそれぞれ割り当てる値と同等である。SHGetIconOverlayIndex
はオーバーレイインデックスを返す。オーバーレイインデックスを対応するイメージインデックスに変換するには、INDEXTOOVERLAYMASK
を呼び出す。注 初期化中にイメージがシステムイメージリストに読み込まれた後は、変更できない。pszIconPath と
iIconIndex
で指定されたファイル名とインデックスはアイコンオーバーレイを識別するためにのみ使用される。SHGetIconOverlayIndex
はシステムイメージリストの変更には使用できない。
> [!NOTE] > shlobj_core.h ヘッダーは SHGetIconOverlayIndex を、UNICODE
プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode
版を自動的に選択するエイリアスとして定義している。エンコーディング中立なエイリアスとそうでないコードを混在して使用すると、コンパイルや実行時のエラーにつながる不一致が発生する場合がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報