Skip to main content

Windows Dev Center

FileInformation.GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) | getThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions) method

Retrieves the thumbnail that is associated with the StorageFile, based on the specified options.

Syntax


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

public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(
  ThumbnailMode mode, 
  uint requestedSize, 
  ThumbnailOptions options
)

Public Function GetThumbnailAsync(
  mode As ThumbnailMode,  
  requestedSize As UInteger,  
  options As ThumbnailOptions 
) As IAsyncOperation(Of StorageItemThumbnail)

public:
IAsyncOperation<StorageItemThumbnail>^ GetThumbnailAsync(
  ThumbnailMode mode, 
  unsigned int requestedSize, 
  ThumbnailOptions options
)

Parameters

mode

Type: ThumbnailMode

The thumbnail mode to retrieve.

requestedSize

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

The requested size in pixels of thumbnail to retrieve.

options

Type: ThumbnailOptions

The thumbnail retrieval options.

Return value

Type: IAsyncOperation<StorageItemThumbnail>

When this method completes successfully, it returns the thumbnail image as a StorageItemThumbnail object.

Requirements (Windows 10 device family)

Device family

Universal

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

None supported

Namespace

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

Metadata

Windows.winmd

See also

FileInformation
GetThumbnailAsync(ThumbnailMode)
GetThumbnailAsync(ThumbnailMode, UInt32)