StorageFileQueryResult.FindStartIndexAsync(Object) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
指定したプロパティ値 ( FileActivatedEventArgs.NeighboringFilesQuery で使用する場合は file) と最も一致するクエリ結果からファイルのインデックスを取得します。 一致するプロパティは、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 で検索するときに一致するファイル。
戻り値
このメソッドが正常に完了すると、クエリ結果で一致したファイルのインデックス、または FileActivatedEventArgs.NeighboringFilesQuery 内のファイルのインデックスが返されます。 後者の場合、ファイルは FileActivatedEventArgs.Files から取得されることが想定されています。 この関数が失敗した場合は、uint を返します 。MaxValue。
実装
- 属性
例
次の使用例は、アルバムタイトルごとにグループ化された曲を含むクエリ結果のセットで、タイトルが "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 と組み合わせて使用すると、元のビューの並べ替え順序を維持しながら、隣接するファイル間を反復処理できます。