storagefile_getscaledimageasthumbnailasync_1603417158.md

-api-id	-api-type
M:Windows.Storage.StorageFile.GetScaledImageAsThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode)	winrt method

Windows.Storage.StorageFile.GetScaledImageAsThumbnailAsync

-description

Gets a scaled image as a thumbnail, determined by the purpose of the thumbnail.

-parameters

-param mode

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.

-returns

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

While GetThumbnailAsync adheres to the max size supported by the thumbnail disk cache, GetScaledImageAsThumbnailAsync can extract thumbnails that are larger than what the thumbnail disk cache supports. GetScaledImageAsThumbnailAsync provides optimal quality but can affect performance by not using the disk cache if the thumbnail size is too large.

-examples

-see-also

GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32), GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions), GetThumbnailAsync(ThumbnailMode), GetThumbnailAsync(ThumbnailMode, UInt32), GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)