This topic has not yet been rated - Rate this topic

IStorageItemProperties.GetThumbnailAsync(ThumbnailMode, UInt32) method

Retrieves an adjusted thumbnail image for the item, determined by the purpose of the thumbnail and the requested size.

Syntax


IAsyncOperation<StorageItemThumbnail>^ GetThumbnailAsync(
  ThumbnailMode mode, 
  unsigned int requestedSize
)

Parameters

mode

Type: ThumbnailMode

The enum value that describes the purpose of the thumbnail and determines how the thumbnail image is adjusted.

For guidance about choosing the best thumbnail mode, see Guidelines and checklist for thumbnails.

requestedSize

Type: System.UInt32 [.NET] | uint32 [C++]

The requested size, in pixels, of the longest edge of the thumbnail. Windows uses the requestedSize as a guide and tries to scale the thumbnail image without reducing the quality of the image.

If Windows can't find a thumbnail image that it can scale to meet the requested size, a larger thumbnail might be returned. If no larger thumbnail is available, a thumbnail image that is smaller than the requested size might be returned.

Return value

Type: IAsyncOperation<StorageItemThumbnail>

When this method completes successfully, it returns a StorageItemThumbnail that represents the thumbnail image or null if there is no thumbnail image associated with the item.

Remarks

For guidance about choosing the best thumbnail mode, see Guidelines and checklist for thumbnails.

Windows Phone 8

This API is not implemented and will throw an exception if called.

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Minimum supported phone	Windows Phone 8
Namespace	Windows.Storage Windows::Storage [C++]
Metadata	Windows.winmd