StorageFile.GetThumbnailAsync 方法

  • 参考

定义

命名空间:
Windows.Storage

重载

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

检索文件的调整缩略图图像，该图像由缩略图的用途、请求的大小和指定的选项决定。
GetThumbnailAsync(ThumbnailMode)

检索文件的调整缩略图图像，由缩略图的用途决定。
GetThumbnailAsync(ThumbnailMode, UInt32)

检索文件的调整缩略图图像，由缩略图的用途和请求的大小决定。

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

编辑

检索文件的调整缩略图图像，该图像由缩略图的用途、请求的大小和指定的选项决定。

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)

参数

mode
ThumbnailMode

枚举值，用于描述缩略图的用途，并确定缩略图图像的调整方式。

有关选择最佳缩略图模式的指导，请参阅 缩略图指南和清单。

requestedSize
UInt32

unsigned int

uint32_t

缩略图最长边缘的请求大小（以像素为单位）。 Windows 使用 requestedSize 作为指导，并尝试在不降低图像质量的情况下缩放缩略图。

如果 Windows 找不到可缩放以满足请求大小的缩略图，可能会返回更大的缩略图。 如果没有更大的缩略图可用，可能会返回小于请求大小的缩略图。

options
ThumbnailOptions

枚举值，该值描述用于检索缩略图图像的所需行为。 指定的行为可能会影响图像的大小和/或质量，以及检索缩略图图像的速度。

返回

IAsyncOperation<StorageItemThumbnail>

此方法成功完成后，它将返回表示缩略图的 StorageItemThumbnail ;如果没有与该文件关联的缩略图图像，则返回 null 。

实现

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)
属性
OverloadAttribute RemoteAsyncAttribute

示例

此示例演示如何使用 [storageFile.getThumbnailAsync (模式、requestedSize、选项) 方法捕获文件的缩略图。

storageFile.getThumbnailAsync(
    Windows.Storage.FileProperties.ThumbnailMode.musicView,
    100,
    Windows.Storage.FileProperties.ThumbnailOptions.useCurrentScale).then(
        function (storageItemThumbnail) {
            // Add code to process thumbnail
        }
    );

在示例) 中，必须有一个 StorageFile 对象 (storageFile ，该对象表示文件，才能使用 StorageFile.GetThumbnailAsync 方法之一。

注解

虽然 GetThumbnailAsync 遵循缩略图磁盘缓存支持的最大大小，但 GetScaledImageAsThumbnailAsync 可以提取大于缩略图磁盘缓存支持的大小的缩略图。 GetScaledImageAsThumbnailAsync 提供最佳质量，但如果缩略图太大，则不使用磁盘缓存可能会影响性能。

另请参阅

适用于

GetThumbnailAsync(ThumbnailMode)

编辑

检索文件的调整缩略图图像，由缩略图的用途决定。

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)

参数

mode
ThumbnailMode

枚举值，用于描述缩略图的用途，并确定缩略图图像的调整方式。

有关选择最佳缩略图模式的指导，请参阅 缩略图指南和清单。

返回

IAsyncOperation<StorageItemThumbnail>

此方法成功完成后，它将返回表示缩略图的 StorageItemThumbnail ;如果没有与该文件关联的缩略图图像，则返回 null 。

实现

GetThumbnailAsync(ThumbnailMode)
属性
OverloadAttribute RemoteAsyncAttribute

注解

虽然 GetThumbnailAsync 遵循缩略图磁盘缓存支持的最大大小，但 GetScaledImageAsThumbnailAsync 可以提取大于缩略图磁盘缓存支持的大小的缩略图。 GetScaledImageAsThumbnailAsync 提供最佳质量，但如果缩略图太大，则不使用磁盘缓存可能会影响性能。

另请参阅

适用于

GetThumbnailAsync(ThumbnailMode, UInt32)

编辑

检索文件的调整缩略图图像，由缩略图的用途和请求的大小决定。

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)

参数

mode
ThumbnailMode

枚举值，用于描述缩略图的用途，并确定缩略图图像的调整方式。

有关选择最佳缩略图模式的指导，请参阅 缩略图指南和清单。

requestedSize
UInt32

unsigned int

uint32_t

缩略图最长边缘的请求大小（以像素为单位）。 Windows 使用 requestedSize 作为指导，并尝试在不降低图像质量的情况下缩放缩略图。

如果 Windows 找不到可缩放以满足请求大小的缩略图，可能会返回更大的缩略图。 如果没有更大的缩略图可用，可能会返回小于请求大小的缩略图。

返回

IAsyncOperation<StorageItemThumbnail>

此方法成功完成后，它将返回表示缩略图的 StorageItemThumbnail ;如果没有与该文件关联的缩略图图像，则返回 null 。

实现

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)
属性
OverloadAttribute RemoteAsyncAttribute

注解

虽然 GetThumbnailAsync 遵循缩略图磁盘缓存支持的最大大小，但 GetScaledImageAsThumbnailAsync 可以提取大于缩略图磁盘缓存支持的大小的缩略图。 GetScaledImageAsThumbnailAsync 提供最佳质量，但如果缩略图太大，则不使用磁盘缓存可能会影响性能。

另请参阅

适用于