Método IThumbnailCache::GetThumbnail (thumbcache.h)

  • Artículo

Obtiene una miniatura almacenada en caché para un elemento shell determinado.

Sintaxis

HRESULT GetThumbnail(
  [in]            IShellItem      *pShellItem,
  [in]            UINT            cxyRequestedThumbSize,
  [in]            WTS_FLAGS       flags,
  [out, optional] ISharedBitmap   **ppvThumb,
  [out, optional] WTS_CACHEFLAGS  *pOutFlags,
  [out, optional] WTS_THUMBNAILID *pThumbnailID
);

Parámetros

[in] pShellItem

Tipo: IShellItem*

Puntero al elemento shell para el que se va a recuperar una miniatura.

[in] cxyRequestedThumbSize

Tipo: UINT

Tamaño de miniatura solicitado en píxeles. El valor máximo es 1024.

[in] flags

Tipo: WTS_FLAGS

Combinación de valores de la enumeración WTS_FLAGS . Consulte la sección Comentarios para ver las reglas y una lista de posibles combinaciones.

[out, optional] ppvThumb

Tipo: ISharedBitmap**

La dirección de un puntero ISharedBitmap que, cuando este método devuelve correctamente, recibe el objeto utilizado para tener acceso a la miniatura. Este parámetro puede ser NULL.

[out, optional] pOutFlags

Tipo: WTS_CACHEFLAGS*

Puntero a un valor que, cuando este método devuelve correctamente, recibe una combinación de las marcas siguientes de la enumeración WTS_CACHEFLAGS.

WTS_DEFAULT (0x00000000)

0x00000000.

WTS_LOWQUALITY (0x00000001)

0x00000001. Se establece cuando las dimensiones de mapa de bits devueltas son inferiores a cxyRequestedThumbSize.

WTS_CACHED (0x00000002)

0x00000002. Se establece cuando la imagen devuelta está en la memoria caché.

[out, optional] pThumbnailID

Tipo: WTS_THUMBNAILID*

Puntero a un valor que, cuando este método devuelve correctamente, recibe un identificador único para la miniatura devuelta. Este parámetro puede ser NULL, en cuyo caso se descarta el identificador de miniatura.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se ejecuta correctamente o si un valor de error COM estándar de lo contrario, incluido lo siguiente:

Código devuelto Descripción
E_INVALIDARG
 Si se devuelve este valor, significará que el parámetro en cuestión no es válido.
WTS_E_FAILEDEXTRACTION
 El elemento shell no admite la extracción de miniaturas. Por ejemplo, .exe o .lnk elementos.
WTS_E_EXTRACTIONTIMEDOUT
 La extracción tardó más tiempo que el tiempo máximo permitido. No se completó la extracción.
WTS_E_SURROGATEUNAVAILABLE
 Un proceso suplente no estaba disponible para usarse para el proceso de extracción.
WTS_E_FASTEXTRACTIONNOTSUPPORTED
 Se estableció la marca WTS_FASTEXTRACT, pero la extracción rápida no está disponible.

Comentarios

Si se extrae una miniatura, se almacenará en caché a menos que se especifique WTS_EXTRACTDONOTCACHE.

Las combinaciones siguientes son válidas para el parámetro flags.

WTS_INCACHEONLY
WTS_FASTEXTRACT
WTS_EXTRACT
WTS_EXTRACT | WTS_SLOWRECLAIM
WTS_FORCEEXTRACTION
WTS_FORCEEXTRACTION | WTS_SLOWRECLAIM
WTS_EXTRACTDONOTCACHE
 

GetImage también usa esta memoria caché y puede proporcionar una manera más sencilla de recuperar la miniatura. Sin embargo, GetImage es más general y recuperará un icono como reserva.

Requisitos

Requisito Value
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado thumbcache.h

Consulte también

IShellItemImageFactory::GetImage

IThumbnailCache