StorageFile.GetThumbnailAsync(ThumbnailMode, UInt32) | getThumbnailAsync(ThumbnailMode, UInt32) method

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

Syntax

storageFile.getThumbnailAsync(mode, requestedSize).done( /* Your success and error handlers */ );

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: Number [JavaScript] | 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 file.

Remarks

Windows Phone 8

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

Requirements

See also

StorageFile

GetThumbnailAsync(ThumbnailMode)

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Build date: 2/25/2013