StorageFileQueryResult.FindStartIndexAsync(Object) 方法

定义

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

public:
 virtual IAsyncOperation<unsigned int> ^ FindStartIndexAsync(Platform::Object ^ value) = FindStartIndexAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<uint32_t> FindStartIndexAsync(IInspectable const& value);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<uint> FindStartIndexAsync(object value);
function findStartIndexAsync(value)
Public Function FindStartIndexAsync (value As Object) As IAsyncOperation(Of UInteger)

参数

value
Object

Platform::Object

IInspectable

搜索查询结果时要匹配的属性值。 用于匹配此值的 属性是 QueryOptions.SortOrder 列表的第一个 SortEntry 中的 属性。

或者,使用 FileActivatedEventArgs.NeighboringFilesQuery 进行搜索时要匹配的文件。

返回

IAsyncOperation<UInt32>

Windows.Foundation.IAsyncOperation

IAsyncOperation<uint32_t>

此方法成功完成后,它会在查询结果中返回匹配文件的索引,或在 FileActivatedEventArgs.NeighboringFilesQuery 中返回该文件的索引。 在后一种情况下,文件应来自 FileActivatedEventArgs.Files。 如果此函数失败,则返回 uint。MaxValue

实现

M:Windows.Storage.Search.IStorageQueryResultBase.FindStartIndexAsync(System.Object) M:Windows.Storage.Search.IStorageQueryResultBase.FindStartIndexAsync(Platform::Object) M:Windows.Storage.Search.IStorageQueryResultBase.FindStartIndexAsync(IInspectable)
属性

示例

此示例演示如何在包含按专辑标题分组的歌曲的查询结果集中找到标题以“R”开头的专辑中的第一首歌曲。

QueryOptions queryOptions = new QueryOptions();
queryOptions.FolderDepth = FolderDepth.Deep;
queryOptions.IndexerOption = IndexerOption.OnlyUseIndexer;
SortEntry album = new SortEntry();
album.AscendingOrder = true;
album.PropertyName = "System.Music.AlbumTitle";
queryOptions.SortOrder.Add(album);

StorageFileQueryResult queryResult = musicFolder.CreateFileQueryWithOptions(queryOptions);
var firstIndex = await queryResult.FindStartIndexAsync("R");

注解

可以将此方法与 FileActivatedEventArgs.NeighboringFilesQuery 结合使用,在相邻文件之间循环访问,同时保留原始视图的排序顺序。

适用于