IShellIconOverlayManager::OverlayIndexFromImageIndex method (shlobj_core.h)

Finds the index of an overlay image for the specified icon image. It can add an overlay if one is not found for the icon.

Syntax

HRESULT OverlayIndexFromImageIndex(
  [in]  int  iImage,
  [out] int  *piIndex,
  [in]  BOOL fAdd
);

Parameters

[in] iImage

Type: int

The existing shell image list index to look for.

[out] piIndex

Type: int

The returned overlay index.

[in] fAdd

Type: BOOL

Whether to add an image if one is not already present.

Return value

Type: HRESULT

This method can return one of these values.

Return code Description
S_OK
The image index was found.
E_FAIL
An error occurred or the image was not found.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shlobj_core.h
DLL Shell32.dll (version 5.0 or later)

See also

IShellIconOverlay

IShellIconOverlayManager