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 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 shlobj_core.h
DLL Shell32.dll (5.0 或更高版本)

另请参阅

IShellIconOverlay