SHGetIconOverlayIndexA 函式 (shlobj_core.h)

傳回系統映射清單中的重迭圖示索引。

語法

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

參數

[in, optional] pszIconPath

類型: LPCTSTR

長度上限之 null 終止字串 的指標,MAX_PATH 包含包含圖示之檔案的完整路徑。

iIconIndex

類型: int

pszIconPath指向檔案中的圖示索引。 若要要求標準重迭圖示,請將 pszIconPath 設定為 Null,並將 iIconIndex 設定為下列其中一項:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

表示共用資料夾的重迭圖示。

表示連結資料夾或檔案的重迭圖示。

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

表示慢速檔案的重迭圖示。

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 和更新版本。 重迭圖示,表示專案是集合中的預設值。 其中一個範例是預設印表機。

傳回值

類型: int

如果成功,則會傳回系統映射清單中的重迭圖示索引,否則傳回 -1。

備註

圖示重迭是系統映射清單的一部分。 它們有兩個識別碼。 第一個是以單一為基礎的重迭索引,可識別相對於影像清單中其他重迭的重迭。 另一個是識別實際影像的影像索引。 這兩個索引相當於您在將圖示重迭新增至具有ImageList_SetOverlayImage的私人影像清單時,分別指派給iOverlayiImage參數的值。 SHGetIconOverlayIndex 會傳回重迭索引。 若要將重迭索引轉換為其相等影像索引,請呼叫 INDEXTOOVERLAYMASK

注意 在初始化期間將映射載入系統映射清單中之後,就無法變更它。 pszIconPathiIconIndex指定的檔案名和索引只會用來識別圖示重迭。 SHGetIconOverlayIndex 無法用來修改系統映射清單。
 

注意

shlobj_core.h 標頭會將 SHGetIconOverlayIndex 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例

需求

   
最低支援的用戶端 Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限桌面應用程式]
目標平台 Windows
標頭 shlobj_core.h (包含 Shlobj.h、Shlobj_core.h)
程式庫 Shell32.lib
Dll Shell32.dll (5.0 版或更新版本)

另請參閱

IShellIconOverlay

IShellIconOverlayIdentifier