StorageFile.GetThumbnailAsync(ThumbnailMode) | getThumbnailAsync(ThumbnailMode) method (Windows)

This topic has not yet been rated - Rate this topic

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

Syntax


storageFile.getThumbnailAsync(mode).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.

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

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

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