Compartir a través de

Método IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)

  • Artículo

Proporciona la ubicación del mapa de bits de la superposición del icono.

Sintaxis

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

Parámetros

[out] pwszIconFile

Tipo: PWSTR

Cadena Unicode terminada en null que contiene la ruta de acceso completa del archivo que contiene el icono. Los tipos de archivo .dll, .exe y .ico son aceptables. Debe establecer la marca ISIOI_ICONFILE en pdwFlags si devuelve un nombre de archivo.

cchMax

Tipo: int

Tamaño del búfer pwszIconFile , en caracteres Unicode.

[out] pIndex

Tipo: int*

Puntero a un valor de índice utilizado para identificar el icono de un archivo que contiene varios iconos. Debe establecer la marca de ISIOI_ICONINDEX en pdwFlags si devuelve un índice.

[out] pdwFlags

Tipo: DWORD*

Puntero a un mapa de bits que especifica la información que devuelve el método . Este parámetro puede ser uno o ambos de los valores siguientes.

ISIOI_ICONFILE (0x00000001)

La ruta de acceso del archivo de icono se devuelve a través de pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

Hay más de un icono en pwszIconFile. El índice del icono se devuelve a través de pIndex.

Valor devuelto

Tipo: HRESULT

Si este método se realiza correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

El Shell llama a este método en el inicio para que la superposición de iconos del controlador se pueda agregar a la lista de imágenes del sistema. Una vez completada la inicialización, shell llama a GetOverlayInfo cuando necesita mostrar la superposición del icono del controlador.

Nota Una vez que la imagen se ha cargado en la lista de imágenes del sistema durante la inicialización, no se puede cambiar. Después de la inicialización, el nombre de archivo y el índice solo se usan para identificar la superposición del icono. El sistema no cargará una nueva superposición de iconos. Cuando se llama a GetOverlayInfo , el controlador debe devolver el mismo nombre de archivo e índice que se especificaron cuando se llamó a la función por primera vez.
 

Requisitos

   
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 shobjidl_core.h (incluya Shlobj.h)
Archivo DLL Shell32.dll (versión 5.0 o posterior)