Retrieves the cache index of a cached icon.
Syntax
int Shell_GetCachedImageIndex(
LPCWSTR pwszIconPath,
int iIconIndex,
UINT uIconFlags
);
Parameters
- pwszIconPath
-
[in] A pointer to a buffer containing the path to the image file.
- iIconIndex
-
[in] The index of the image within the file named at pwszIconPath.
- uIconFlags
-
[in] The flags controlling the action of the function.
Return Value
Returns the index of the image, or -1 on failure.
Remarks
Shell_GetCachedImageIndex is available in Microsoft Windows 2000 and Windows XP, but might be altered or unavailable in subsequent versions of Windows. It is not available in Windows Millennium Edition (Windows Me).
The Shell_GetCachedImageIndexA and Shell_GetCachedImageIndexW versions of this function are new for Windows Vista. Previous versions supported Shell_GetCachedImageIndex only, which takes a Unicode string.
Function Information
| Minimum DLL Version | shell32.dll version 5.0 or later |
|---|
| Custom Implementation | No |
|---|
| Header | shlobj.h |
|---|
| Import library | shell32.lib |
|---|
| Minimum operating systems |
Windows 2000 |
|---|
| Unicode | Implemented as
ANSI and Unicode versions. |
|---|
See Also
FileIconInit