FileInformation.GetThumbnailAsync Method

Definition

Namespace:

Windows.Storage.BulkAccess

Overloads

GetThumbnailAsync(ThumbnailMode)	Retrieves the thumbnail that is associated with the StorageFile.
GetThumbnailAsync(ThumbnailMode, UInt32)	Retrieves the thumbnail that is associated with the StorageFile, scaling it to the specified size.
GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)	Retrieves the thumbnail that is associated with the StorageFile, based on the specified options.

GetThumbnailAsync(ThumbnailMode)

Retrieves the thumbnail that is associated with the StorageFile.

public:
 virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode) = GetThumbnailAsync;

/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode);

[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode);

function getThumbnailAsync(mode)

Public Function GetThumbnailAsync (mode As ThumbnailMode) As IAsyncOperation(Of StorageItemThumbnail)

Parameters

mode

ThumbnailMode

The thumbnail mode to retrieve.

Returns

IAsyncOperation<StorageItemThumbnail>

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

Implements

GetThumbnailAsync(ThumbnailMode)

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• GetThumbnailAsync(ThumbnailMode, UInt32)
• GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

GetThumbnailAsync(ThumbnailMode, UInt32)

Retrieves the thumbnail that is associated with the StorageFile, scaling it to the specified size.

public:
 virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize) = GetThumbnailAsync;

/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize);

[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize);

function getThumbnailAsync(mode, requestedSize)

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

Parameters

mode

ThumbnailMode

The thumbnail mode to retrieve.

requestedSize

UInt32

unsigned int

uint32_t

The requested size in pixels of thumbnail to retrieve.

Returns

IAsyncOperation<StorageItemThumbnail>

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

Implements

M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,unsigned int) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,uint32_t)

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• GetThumbnailAsync(ThumbnailMode)
• GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

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

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

/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize, ThumbnailOptions const& options);

[Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize, ThumbnailOptions options);

function getThumbnailAsync(mode, requestedSize, options)

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

Parameters

mode

ThumbnailMode

The thumbnail mode to retrieve.

requestedSize

UInt32

unsigned int

uint32_t

The requested size in pixels of thumbnail to retrieve.

options

ThumbnailOptions

The thumbnail retrieval options.

Returns

IAsyncOperation<StorageItemThumbnail>

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

Implements

M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,unsigned int,Windows.Storage.FileProperties.ThumbnailOptions) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,uint32_t,Windows.Storage.FileProperties.ThumbnailOptions)

Attributes

OverloadAttribute RemoteAsyncAttribute

See also

• GetThumbnailAsync(ThumbnailMode)
• GetThumbnailAsync(ThumbnailMode, UInt32)