Compartir a través de

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

  • Artículo

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

Sintaxis

HRESULT GetOverlayIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIndex
);

Parámetros

[in] pidl

Tipo: PCUITEMID_CHILD

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

[in, out] pIndex

Tipo: int*

Puntero a un valor que indica el índice de superposición (basado en uno) en la lista de imágenes del sistema. Este índice es equivalente al valor de iOverlay 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.
E_INVALIDARG
 El argumento no es válido, por ejemplo, si pIndex es NULL.
E_PENDING
 La aplicación que llama pasó OI_ASYNC para indicar que la operación de calcular el índice de superposición tardará algún tiempo.

Comentarios

Para recuperar el índice de superposición en la lista de imágenes del sistema, llame a SHGetIconOverlayIndex.

Si establece pIndex para que apunte a OI_ASYNC al llamar a este método, el controlador de superposición de iconos de Shell podría devolver E_PENDING en lugar de almacenar el índice de superposición en pIndex. Este valor devuelto indica que calcular la superposición es una operación lenta y se debe controlar en segundo plano. Cuando una implementación de IShellIconOverlay devuelve E_PENDING, se llama de nuevo en un subproceso de trabajo en segundo plano sin la marca OI_ASYNC. Si no usa OI_ASYNC al llamar a GetOverlayIndex, el controlador de superposición debe calcular el índice de superposición y almacenar el valor en pIndex antes de devolverlo.

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