通过

StorageFileQueryResult 类

  • 参考

定义

命名空间:
Windows.Storage.Search
编辑

提供对 StorageFolder 对象所表示位置中文件查询结果的访问。 可以使用 StorageFileQueryResult 枚举该 StorageFolder 位置中的文件。

public ref class StorageFileQueryResult sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class StorageFileQueryResult final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class StorageFileQueryResult
Public NotInheritable Class StorageFileQueryResult
继承
Object Platform::Object IInspectable StorageFileQueryResult
属性
ContractVersionAttribute
实现
IStorageQueryResultBase

Windows 要求

设备系列
Windows 10 (在 10.0.10240.0 中引入)
API contract
Windows.Foundation.UniversalApiContract (在 v1.0 中引入)

示例

此示例演示如何从 StorageFileQueryResult 对象获取文件列表。

// Set query options with filter and sort order for results
List<string> fileTypeFilter = new List<string>();
fileTypeFilter.Add(".jpg");
fileTypeFilter.Add(".png");
fileTypeFilter.Add(".bmp");
fileTypeFilter.Add(".gif");
var queryOptions = new QueryOptions(CommonFileQuery.OrderByName, fileTypeFilter);

// Create query and retrieve files
var query = KnownFolders.PicturesLibrary.CreateFileQueryWithOptions(queryOptions);
IReadOnlyList<StorageFile> fileList = await query.GetFilesAsync();
// Process results
foreach (StorageFile file in fileList)
{
    // Process file
}

变量 query 获取 StorageFileQueryResult，用于检索符合查询条件的文件。

注意

你需要图片库功能才能使用 KnownFolders.PicturesLibrary 访问库。 若要详细了解功能和文件访问，请参阅 文件访问权限。

注解

注意

尽管它未使用 marshalling_behavior(agile)进行属性化，但此类可被视为敏捷类。

可以通过从 StorageFolder 或 FolderInformation 对象调用以下方法来获取 StorageFileQueryResult 对象：

属性

Folder

获取查询以创建 StorageFileQueryResult 对象的文件夹。 此文件夹表示查询的范围。

方法

ApplyNewQueryOptions(QueryOptions)

根据新的 QueryOption 修改查询结果。
FindStartIndexAsync(Object)

如果与 FileActivatedEventArgs.NeighboringFilesQuery) 一起使用，则从与指定属性值 (或文件最匹配的查询结果中检索文件的索引。 匹配的属性由 QueryOptions.SortOrder 列表的第一个 SortEntry 确定。
GetCurrentQueryOptions()

检索用于确定查询结果的查询选项。
GetFilesAsync()

检索查询结果集中所有文件的列表。
GetFilesAsync(UInt32, UInt32)

检索指定范围内的文件列表。
GetItemCountAsync()

检索查询结果集中的文件数。
GetMatchingPropertiesWithRanges(StorageFile)

获取具有相应文本范围的匹配文件属性。

事件

ContentsChanged

在查询的文件夹中将文件添加到、从中删除或修改文件时触发。 此事件仅在至少调用 GetFilesAsync 一次后触发。
OptionsChanged

查询选项更改时触发。

适用于

另请参阅