Método IShellIconOverlay::GetOverlayIconIndex (shlobj_core.h)

Obtiene el índice de la superposición de icono en la lista de imágenes del sistema.

Sintaxis

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

Parámetros

[in] pidl

Tipo: PCUITEMID_CHILD

Puntero a una estructura ITEMIDLIST que identifica el objeto cuyo icono se muestra.

[in, out] pIconIndex

Tipo: int*

Puntero al índice de la imagen de la superposición del icono en la lista de imágenes del sistema. Este índice es equivalente al valor de iImage que se especifica al agregar una imagen de superposición a una lista de imágenes privadas con la función ImageList::SetOverlayImage .

Valor devuelto

Tipo: HRESULT

Este método puede devolver uno de estos valores.

Código devuelto	Descripción
S_OK	Se encontró el índice de una superposición.
S_FALSE	No existe ninguna superposición para este archivo.
E_FAIL	El PIDL no es válido.

Comentarios

Para recuperar el índice de imagen de la superposición en la lista de imágenes del sistema, primero debe llamar a SHGetIconOverlayIndex para recuperar el índice de superposición. A continuación, use la macro INDEXTOOVERLAYMASK para convertir el índice de superposición en el índice de imagen equivalente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	shlobj_core.h
Archivo DLL	Shell32.dll (versión 5.0 o posterior)

Consulte también

IShellIconOverlay