StorageFolderQueryResult クラス

リファレンス

定義

名前空間:: Windows.Storage.Search

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

編集

クエリ対象のフォルダー (またはファイルグループ) を一覧表示するクエリの結果 ( StorageFolder によって表される) へのアクセスを提供します。 StorageFolderQueryResult を使用して、そのフォルダー内のフォルダーまたはファイルグループを列挙できます。

public ref class StorageFolderQueryResult sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class StorageFolderQueryResult final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class StorageFolderQueryResult

Public NotInheritable Class StorageFolderQueryResult

継承: Object Platform::Object IInspectable StorageFolderQueryResult

属性: ContractVersionAttribute

実装: IStorageQueryResultBase

Windows の要件

デバイスファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

この例では、StorageFolderQueryResult オブジェクトからリストフォルダー (またはファイルグループ) を取得する方法を示します。

// Get the Pictures library
Windows.Storage.StorageFolder picturesLibrary = Windows.Storage.KnownFolders.PicturesLibrary;

// Set query options to create groups of files within result
QueryOptions queryOptions = new QueryOptions(Windows.Storage.Search.CommonFolderQuery.GroupByMonth);

// Create query and retrieve result
StorageFolderQueryResult queryResult = picturesLibrary.CreateFolderQueryWithOptions(queryOptions);
IReadOnlyList<StorageFolder> folders = await queryResult.GetFoldersAsync();
// Process file groups
foreach (StorageFolder folder in folders)
{
    // Get and process files in group
    IReadOnlyList<StorageFile> fileList = await folder.GetFilesAsync();
    OutputPanel.Children.Add(CreateHeaderTextBlock(folder.Name + " (" + fileList.Count + ")"));
    foreach (StorageFile file in fileList)
    {
        // Process file
    }
}

変数は queryResult 、クエリの条件を満たすファイルグループ (またはフォルダー) を取得するために使用される StorageFolderQueryResult を取得します。

注意

KnownFolders.PicturesLibrary を使用してライブラリにアクセスするには、画像ライブラリ機能が必要です。機能とファイルアクセスの詳細については、「ファイルアクセス許可」を参照してください。

注釈

注意

では属性付け marshalling_behavior(agile)されませんが、このクラスはアジャイルとして扱うことができます。詳細については、「スレッドとマーシャリング (C++/CX)」を参照してください。

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

storageFolderQueryResult オブジェクトの使用方法を示すその他のコード例については、 Folder 列挙のサンプルを参照してください。

StorageFolderQueryResult オブジェクトを取得して、場所内のフォルダーまたはファイルグループを列挙するには、その場所を表す storageFolder を取得し、フォルダークエリを作成する必要があります。

プロパティ

Folder

StorageFolderQueryResult オブジェクトの作成に最初に使用されたフォルダーを取得します。このフォルダーは、クエリのスコープを表します。

メソッド

ApplyNewQueryOptions(QueryOptions)	新しい QueryOptions に基づいてクエリ結果を変更します。
FindStartIndexAsync(Object)	指定したプロパティ値に最も近いクエリ結果からフォルダーのインデックスを取得します。一致するプロパティは、QueryOptions.SortOrder リストの最初の SortEntry によって決定されます。
GetCurrentQueryOptions()	クエリ結果の決定に使用されるクエリオプションを取得します。
GetFoldersAsync()	結果セット内のすべてのフォルダー (またはファイルグループ) の一覧を取得します。
GetFoldersAsync(UInt32, UInt32)	指定した範囲内のフォルダー (またはファイルグループ) を取得します。
GetItemCountAsync()	クエリ結果のセット内のフォルダー (またはファイルグループ) の数を取得します。

イベント

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

適用対象