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 错误代码。

注解

此方法在启动时由 Shell 调用,以便处理程序的图标覆盖可以添加到系统映像列表。 初始化完成后,Shell 会在需要显示处理程序的图标覆盖时调用 GetOverlayInfo

注意 在初始化期间将映像加载到系统映像列表中后,无法更改该映像。 初始化后,文件名和索引仅用于标识图标覆盖。 系统不会加载新的图标覆盖。 调用 GetOverlayInfo 时,处理程序必须返回首次调用函数时指定的相同文件名和索引。
 

要求

   
最低受支持的客户端 Windows 2000 专业版、Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 shobjidl_core.h (包括 Shlobj.h)
DLL Shell32.dll (5.0 或更高版本)