IThumbnailCache::GetThumbnailByID method
Gets a thumbnail from the thumbnail cache, given its ID.
Syntax
HRESULT GetThumbnailByID( [in] WTS_THUMBNAILID thumbnailID, [in] UINT cxyRequestedThumbSize, [out, optional] ISharedBitmap **ppvThumb, [out, optional] WTS_CACHEFLAGS *pOutFlags );
Parameters
- thumbnailID [in]
-
Type: WTS_THUMBNAILID
The ID of the thumbnail to retrieve. The ID is obtained by calling GetThumbnail.
- cxyRequestedThumbSize [in]
-
Type: UINT
The requested thumbnail size in pixels. This value cannot be larger than 1024.
- ppvThumb [out, optional]
-
Type: ISharedBitmap**
The address of a ISharedBitmap interface pointer that, when this method returns successfully, receives the object for accessing the requested thumbnail. This parameter can be NULL.
- pOutFlags [out, optional]
-
Type: WTS_CACHEFLAGS*
A pointer to a value that, when this method returns successfully, receives a combination of the following flags. This value can be set to NULL if this information is not needed.
Return value
Type: HRESULT
Returns S_OK if successful, or an error value otherwise, including the following:
| Return code | Description |
|---|---|
|
A parameter is invalid. |
|
The Shell item does not support thumbnail extraction. For example, .exe or .lnk items. |
|
The extraction took longer than the maximum allowable time. The extraction was not completed. |
|
A surrogate process was not available to be used for the extraction process. |
|
The WTS_FASTEXTRACT flag was set, but fast extraction is not available. |
Remarks
This method is typically called after GetThumbnail has already been called to retrieve the thumbnail ID.
Requirements
|
Minimum supported client |
Windows Vista [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2008 [desktop apps only] |
|
Header |
|
|
IDL |
|