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

Applies to Windows and Windows Phone

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

Syntax


public:
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: 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

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

  • Applies to Windows Phone

In Windows Phone Store apps, the StorageFile.GetThumbnailAsync method returns the default icon for a music file instead of the expected icon. This happens when you call the StorageFile.GetThumbnailAsync method with a ThumbnailMode value of MusicView.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Storage
Windows::Storage [C++]

Metadata

Windows.winmd

See also

StorageFile
GetThumbnailAsync(ThumbnailMode)
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

 

 

Show:
© 2014 Microsoft