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)されていませんが、このクラスはアジャイルとして扱うことができます。

StorageFileQueryResult オブジェクトを取得するには、 StorageFolder オブジェクトまたは FolderInformation オブジェクトから次のメソッドを呼び出します。

プロパティ

Folder

StorageFileQueryResult オブジェクトを作成するために照会されたフォルダーを取得します。 このフォルダーは、クエリのスコープを表します。

メソッド

ApplyNewQueryOptions(QueryOptions)

新しい QueryOptions に基づいてクエリ結果を変更します。
FindStartIndexAsync(Object)

指定したプロパティ値 ( FileActivatedEventArgs.NeighboringFilesQuery で使用する場合は file) と最も一致するクエリ結果からファイルのインデックスを取得します。 一致するプロパティは、QueryOptions.SortOrder リストの最初の SortEntry によって決まります。
GetCurrentQueryOptions()

クエリ結果を決定するために使用されるクエリ オプションを取得します。
GetFilesAsync()

クエリ結果セット内のすべてのファイルの一覧を取得します。
GetFilesAsync(UInt32, UInt32)

指定した範囲内のファイルの一覧を取得します。
GetItemCountAsync()

クエリ結果のセット内のファイルの数を取得します。
GetMatchingPropertiesWithRanges(StorageFile)

対応するテキスト範囲と一致するファイル プロパティを取得します。

イベント

ContentsChanged

クエリ対象のフォルダーにファイルが追加、削除、または変更されたときに発生します。 このイベントは 、GetFilesAsync が少なくとも 1 回呼び出された後にのみ発生します。
OptionsChanged

クエリ オプションが変更されたときに発生します。

適用対象

こちらもご覧ください