IThumbnailCache::GetThumbnail メソッド (thumbcache.h)

  • [アーティクル]

特定のシェル項目のキャッシュされたサムネイルを取得します。

構文

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

パラメーター

[in] pShellItem

種類: IShellItem*

サムネイルを取得するシェル項目へのポインター。

[in] cxyRequestedThumbSize

型: UINT

要求されたサムネイル サイズ (ピクセル単位)。 最大値は 1024 です。

[in] flags

種類: WTS_FLAGS

WTS_FLAGS列挙からの値の組み合わせ。 ルールと考えられる組み合わせの一覧については、「解説」セクションを参照してください。

[out, optional] ppvThumb

種類: ISharedBitmap**

このメソッドが正常に返されるときに、サムネイルへのアクセスに使用されるオブジェクトを受け取る ISharedBitmap ポインターのアドレス。 このパラメーターは NULL である可能性があります。

[out, optional] pOutFlags

種類: WTS_CACHEFLAGS*

このメソッドが正常に返されるときに、WTS_CACHEFLAGS列挙体から次のフラグの組み合わせを受け取る値へのポインター。

WTS_DEFAULT (0x00000000)

0x00000000。

WTS_LOWQUALITY (0x00000001)

0x00000001。 返されるビットマップ ディメンションが cxyRequestedThumbSize 未満の場合に設定します。

WTS_CACHED (0x00000002)

0x00000002。 返されたイメージがキャッシュ内にある場合に設定します。

[out, optional] pThumbnailID

種類: WTS_THUMBNAILID*

このメソッドが正常に返されるときに、返されたサムネイルの一意の ID を受け取る値へのポインター。 このパラメーターには NULL を指定できます。この場合、サムネイル ID は破棄されます。

戻り値

型: HRESULT

成功した場合はS_OKを返し、それ以外の場合は次のような標準 COM エラー値を返します。

リターン コード 説明
E_INVALIDARG
 パラメーターが無効です。
WTS_E_FAILEDEXTRACTION
 シェル項目はサムネイル抽出をサポートしていません。 たとえば、項目の .exe や.lnkなどです。
WTS_E_EXTRACTIONTIMEDOUT
 抽出に最大許容時間よりも長い時間がかかりました。 抽出は完了していません。
WTS_E_SURROGATEUNAVAILABLE
 サロゲート プロセスを抽出プロセスに使用できませんでした。
WTS_E_FASTEXTRACTIONNOTSUPPORTED
 WTS_FASTEXTRACT フラグが設定されましたが、高速抽出は使用できません。

注釈

サムネイルが抽出された場合、WTS_EXTRACTDONOTCACHEが指定されていない限り、サムネイルはキャッシュされます。

flags パラメーターには、次の組み合わせが有効です。

WTS_INCACHEONLY
WTS_FASTEXTRACT
WTS_EXTRACT
WTS_EXTRACT |WTS_SLOWRECLAIM
WTS_FORCEEXTRACTION
WTS_FORCEEXTRACTION |WTS_SLOWRECLAIM
WTS_EXTRACTDONOTCACHE
 

GetImage では、このキャッシュも使用され、サムネイルを取得する簡単な方法を提供できます。 ただし、 GetImage はより一般的であり、フォールバックとしてアイコンを取得します。

要件

要件 値
サポートされている最小のクライアント Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー thumbcache.h

こちらもご覧ください

IShellItemImageFactory::GetImage

IThumbnailCache