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

Article
08/26/2023

Obtient une miniature mise en cache pour un élément Shell donné.

Syntaxe

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
);

Paramètres

[in] pShellItem

Type : IShellItem*

Pointeur vers l’élément Shell pour lequel récupérer une miniature.

[in] cxyRequestedThumbSize

Type : UINT

Taille de miniature demandée en pixels. La valeur maximale est 1024.

[in] flags

Type : WTS_FLAGS

Combinaison de valeurs de l’énumération WTS_FLAGS . Consultez la section Remarques pour connaître les règles et la liste des combinaisons possibles.

[out, optional] ppvThumb

Type : ISharedBitmap**

Adresse d’un pointeur ISharedBitmap qui, lorsque cette méthode retourne correctement, reçoit l’objet utilisé pour accéder à la miniature. Ce paramètre peut avoir la valeur NULL.

[out, optional] pOutFlags

Type : WTS_CACHEFLAGS*

Pointeur vers une valeur qui, lorsque cette méthode retourne correctement, reçoit une combinaison des indicateurs suivants de l’énumération WTS_CACHEFLAGS.

WTS_DEFAULT (0x00000000)

0x00000000.

WTS_LOWQUALITY (0x00000001)

0x00000001. Défini lorsque les dimensions bitmap retournées sont inférieures à cxyRequestedThumbSize.

WTS_CACHED (0x00000002)

0x00000002. Défini lorsque l’image retournée se trouve dans le cache.

[out, optional] pThumbnailID

Type : WTS_THUMBNAILID*

Pointeur vers une valeur qui, lorsque cette méthode retourne correctement, reçoit un ID unique pour la miniature retournée. Ce paramètre peut être NULL, auquel cas l’ID de miniature est ignoré.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite ou une valeur d’erreur COM standard dans le cas contraire, y compris les éléments suivants :

Code de retour	Description
E_INVALIDARG	Un paramètre n'est pas valide.
WTS_E_FAILEDEXTRACTION	L’élément Shell ne prend pas en charge l’extraction de miniatures. Par exemple, .exe ou .lnk éléments.
WTS_E_EXTRACTIONTIMEDOUT	L’extraction a pris plus de temps que le temps maximal autorisé. L’extraction n’a pas été terminée.
WTS_E_SURROGATEUNAVAILABLE	Un processus de substitution n’était pas disponible pour être utilisé pour le processus d’extraction.
WTS_E_FASTEXTRACTIONNOTSUPPORTED	L’indicateur WTS_FASTEXTRACT a été défini, mais l’extraction rapide n’est pas disponible.

Remarques

Si une miniature est extraite, elle est mise en cache, sauf si WTS_EXTRACTDONOTCACHE est spécifié.

Les combinaisons suivantes sont valides pour le paramètre flags.

WTS_INCACHEONLY

WTS_FASTEXTRACT

WTS_EXTRACT

WTS_EXTRACT | WTS_SLOWRECLAIM

WTS_FORCEEXTRACTION

WTS_FORCEEXTRACTION | WTS_SLOWRECLAIM

WTS_EXTRACTDONOTCACHE

GetImage utilise également ce cache et peut fournir un moyen plus facile de récupérer la miniature. Toutefois, GetImage est plus général et récupère une icône en guise de secours.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	thumbcache.h

Voir aussi

IShellItemImageFactory ::GetImage

IThumbnailCache

Partager via