StorageFolder.CreateFileQuery メソッド

定義

名前空間:

Windows.Storage

オーバーロード

CreateFileQuery()	現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。
CreateFileQuery(CommonFileQuery)	現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。 また、 クエリ 引数の値が CommonFileQuery.DefaultQuery 以外の値である場合は、現在のフォルダーのサブフォルダーからファイルを取得します。 ファイルは、指定された CommonFileQuery に基づいて並べ替えられます。

CreateFileQuery()

現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。

public:
 virtual StorageFileQueryResult ^ CreateFileQuery() = CreateFileQuery;

/// [Windows.Foundation.Metadata.Overload("CreateFileQueryOverloadDefault")]
StorageFileQueryResult CreateFileQuery();

[Windows.Foundation.Metadata.Overload("CreateFileQueryOverloadDefault")]
public StorageFileQueryResult CreateFileQuery();

function createFileQuery()

Public Function CreateFileQuery () As StorageFileQueryResult

戻り値

StorageFileQueryResult

クエリ結果オブジェクト。 クエリ結果の GetFilesAsync メソッドを呼び出して、ファイルのフラット リストを取得します。 このメソッドは、IReadOnlyList<StorageFile 型のリストを返します>。 各ファイルは、 StorageFile 型の項目で表されます。

実装

CreateFileQuery()

属性

OverloadAttribute

例

次の例では、CreateFileQuery() メソッドを呼び出して、現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。

using Windows.Storage;
using Windows.Storage.Search;
using System.Threading.Tasks;
using System.Diagnostics; // For writing results to Output window.

// Get the app's installation folder.
StorageFolder appFolder = Windows.ApplicationModel.Package.Current.InstalledLocation;

// Get the files in the current folder.
StorageFileQueryResult results = appFolder.CreateFileQuery();

// Iterate over the results and print the list of files
// to the Visual Studio Output window.
IReadOnlyList<StorageFile> filesInFolder = await results.GetFilesAsync();
foreach (StorageFile item in filesInFolder)
{
    Debug.WriteLine(item.Name);
}

IAsyncAction MainPage::ExampleCoroutineAsync()
{
    // Get the app's installation folder.
    Windows::Storage::StorageFolder appFolder{ Windows::ApplicationModel::Package::Current().InstalledLocation() };
    // Get the files in the current folder.
    Windows::Storage::Search::StorageFileQueryResult results{ appFolder.CreateFileQuery() };

    Windows::Foundation::Collections::IVectorView<Windows::Storage::StorageFile> filesInFolder{
        co_await results.GetFilesAsync() };

    // Iterate over the results, and print the list of files to the Visual Studio output window.
    for (StorageFile const& fileInFolder : filesInFolder)
    {
        std::wstring output{ fileInFolder.Name() };
        ::OutputDebugString(output.c_str());
    }
}

//Get the app's installation folder
StorageFolder^ appFolder = Windows::ApplicationModel::Package::Current->InstalledLocation;
//Get the files in the current folder
StorageFileQueryResult^ results = appFolder->CreateFileQuery();

create_task(results->GetFilesAsync()).then([=](IVectorView<StorageFile^>^ filesInFolder) {
 //Iterate over the results and print the list of files
 // to the visual studio output window
 for (auto it = filesInFolder->First(); it->HasCurrent; it->MoveNext())
 {
  StorageFile^ file = it->Current;
  String^ output = file->Name + "\n";
  OutputDebugString(output->Begin());
 }
});

注釈

このクエリは、現在のフォルダー内のファイルのみを返すシャロー クエリです。 シャロー クエリとディープ クエリを識別するメソッドの一覧については、「 GetFilesAsync」トピックの「解説」を参照してください。

GetFilesAsync メソッドのいずれかを呼び出すことで、現在のフォルダー内のファイルの一覧を非同期的に取得することもできます。

追加のクエリ オプションを指定するには、 CreateFileQueryWithOptions メソッドを 呼び出します。

ファイルまたはフォルダーであるアイテムを取得するには、 CreateItemQuery メソッドを呼び出します。

こちらもご覧ください

• CreateFileQuery(CommonFileQuery)
• CreateFileQueryWithOptions(QueryOptions)

CreateFileQuery(CommonFileQuery)

現在のフォルダー内のファイルを含むクエリ結果オブジェクトを取得します。 また、 クエリ 引数の値が CommonFileQuery.DefaultQuery 以外の値である場合は、現在のフォルダーのサブフォルダーからファイルを取得します。 ファイルは、指定された CommonFileQuery に基づいて並べ替えられます。

public:
 virtual StorageFileQueryResult ^ CreateFileQuery(CommonFileQuery query) = CreateFileQuery;

/// [Windows.Foundation.Metadata.Overload("CreateFileQuery")]
StorageFileQueryResult CreateFileQuery(CommonFileQuery const& query);

[Windows.Foundation.Metadata.Overload("CreateFileQuery")]
public StorageFileQueryResult CreateFileQuery(CommonFileQuery query);

function createFileQuery(query)

Public Function CreateFileQuery (query As CommonFileQuery) As StorageFileQueryResult

パラメーター

query

CommonFileQuery

ファイルの並べ替え方法を指定し、クエリが浅いか深いかを決定する列挙値の 1 つ。

戻り値

StorageFileQueryResult

クエリ結果オブジェクト。 クエリ結果の GetFilesAsync メソッドを呼び出して、クエリで指定されたとおりに並べ替えられたファイルのフラット リストを取得 します。 このメソッドは、IReadOnlyList<StorageFile 型のリストを返します>。 各ファイルは、 StorageFile 型の項目で表されます。

実装

CreateFileQuery(CommonFileQuery)

属性

OverloadAttribute

例外

ArgumentException

ライブラリ フォルダーではないフォルダーに対して<、xref:Windows.Storage.Search.CommonFileQuery?text=CommonFileQuery 列挙から DefaultQuery> 以外の値を指定しました。 クエリの値を確認 します。

注釈

CommonFileQuery は、特定のファイル属性 (タイトルや日付など) に基づいてファイルをすばやく簡単に並べ替えます。

CommonFileQuery 列挙から DefaultQuery オプションを指定すると、このクエリは現在のフォルダー内のファイルのみを返すシャロー クエリです。 CommonFileQuery 列挙から別の値を指定すると、このクエリは、現在のフォルダーとそのサブフォルダーからフラット化されたファイルの一覧を返すディープ クエリです。

ヒント

CommonFileQuery 列挙の値の一部は、ライブラリ フォルダー (Pictures ライブラリなど) または Homegroup フォルダーでのみ使用できます。 DefaultQuery オプションに加えて、OrderByName オプションと OrderBySearchRank オプションのみをライブラリ フォルダーではないフォルダーと共に使用できます。

シャロー クエリとディープ クエリを識別するメソッドの一覧については、「 GetFilesAsync」トピックの「解説」を参照してください。

特定の CommonFileQuery を使用できるかどうかをチェックするには、フォルダーの IsCommonFileQuerySupported メソッドを呼び出します。

GetFilesAsync メソッドのいずれかを呼び出すことで、現在のフォルダー内のファイルの一覧を非同期的に取得することもできます。

Windows Server 2012 の場合 既定ではインデクサー コンポーネントがインストールされないため、一部の CommonFileQuery 値を使用するにはインデクサー コンポーネントをインストールする必要があります。

こちらもご覧ください

• CreateFileQuery()
• CreateFileQueryWithOptions(QueryOptions)