Compartir a través de

Función SHGetIconOverlayIndexA (shlobj_core.h)

  • Artículo

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

Sintaxis

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

Parámetros

[in, optional] pszIconPath

Tipo: LPCTSTR

Puntero a una cadena terminada en null de longitud máxima MAX_PATH que contiene la ruta de acceso completa del archivo que contiene el icono.

iIconIndex

Tipo: int

Índice del icono en el archivo al que apunta pszIconPath. Para solicitar un icono de superposición estándar, establezca pszIconPath en NULL e iIconIndex en uno de los siguientes:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Icono de superposición que indica una carpeta compartida.

Icono de superposición que indica una carpeta o archivo vinculados.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Icono de superposición que indica un archivo lento.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 y versiones posteriores. Icono de superposición que indica que el elemento es el valor predeterminado en un conjunto. Un ejemplo es la impresora predeterminada.

Valor devuelto

Tipo: int

Devuelve el índice del icono de superposición en la lista de imágenes del sistema si se ejecuta correctamente o -1 de lo contrario.

Comentarios

Las superposiciones de icono forman parte de la lista de imágenes del sistema. Tienen dos identificadores. La primera es un índice de superposición basado en uno que identifica la superposición en relación con otras superposiciones de la lista de imágenes. El otro es un índice de imagen que identifica la imagen real. Estos dos índices son equivalentes a los valores que se asignan a los parámetros iOverlay e iImage , respectivamente, al agregar una superposición de icono a una lista de imágenes privadas con ImageList_SetOverlayImage. SHGetIconOverlayIndex devuelve el índice de superposición. Para convertir un índice de superposición en su índice de imagen equivalente, llame a INDEXTOOVERLAYMASK.

Nota Después de cargar la imagen en la lista de imágenes del sistema durante la inicialización, no se puede cambiar. El nombre de archivo y el índice especificados por pszIconPath e iIconIndex solo se usan para identificar la superposición del icono. SHGetIconOverlayIndex no se puede usar para modificar la lista de imágenes del sistema.
 

Nota

El encabezado shlobj_core.h define SHGetIconOverlayIndex como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

   
Cliente mínimo compatible Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shlobj_core.h (incluya Shlobj.h, Shlobj_core.h)
Library Shell32.lib
Archivo DLL Shell32.dll (versión 5.0 o posterior)

Consulte también

IShellIconOverlay

IShellIconOverlayIdentifier