StorageFolder.GetFilesAsync メソッド

public:
 virtual IAsyncOperation<IVectorView<StorageFile ^> ^> ^ GetFilesAsync() = GetFilesAsync;

/// [Windows.Foundation.Metadata.Overload("GetFilesAsyncOverloadDefaultOptionsStartAndCount")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync();

[Windows.Foundation.Metadata.Overload("GetFilesAsyncOverloadDefaultOptionsStartAndCount")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync();

function getFilesAsync()

Public Function GetFilesAsync () As IAsyncOperation(Of IReadOnlyList(Of StorageFile))

戻り値

このメソッドが正常に完了すると、現在のフォルダー内のファイルの一覧が返されます。 リストの種類は IReadOnlyList<StorageFile です>。 リスト内の各ファイルは、 StorageFile オブジェクトによって表されます。

実装

属性

OverloadAttribute RemoteAsyncAttribute

例外

例

次の例は、 GetFilesAsync(CommonFileQuery, UInt32, UInt32) オーバーロードメソッドを呼び出して、ユーザーの Pictures フォルダーとそのサブフォルダーの内容を日付順に並べ替える方法を示しています。 次の使用例は、インデックス 0 から始まる最大 20 個のファイルを返します。 CommonFileQuery.OrderByDate オプションは日付を降順 (つまり、最新から最も古いもの) で並べ替えるため、この例ではユーザーの最新の写真 20 枚を返します。

次の例を実行する前に、アプリ マニフェスト ファイルで Pictures Library 機能を有効にします。

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

// Get the user's Pictures folder.
// Enable the corresponding capability in the app manifest file.
StorageFolder picturesFolder = KnownFolders.PicturesLibrary;

// Get the first 20 files in the current folder, sorted by date.
IReadOnlyList<StorageFile> sortedItems = await picturesFolder.GetFilesAsync(CommonFileQuery.OrderByDate,0,20);

// Iterate over the results and print the list of files
// to the Visual Studio Output window.
foreach (StorageFile file in sortedItems)
    Debug.WriteLine(file.Name + ", " + file.DateCreated);

#include <winrt/Windows.Storage.h>
#include <winrt/Windows.Storage.Search.h>
...
IAsyncAction ExampleCoroutineAsync()
{
    // Get the user's Pictures library.
    // Enable the Pictures Library capability in the app manifest file.
    Windows::Storage::StorageFolder picturesLibrary{ Windows::Storage::KnownFolders::PicturesLibrary() };

    // Get the first 20 sorted images in the library, sorted by date.
    Windows::Foundation::Collections::IVectorView<Windows::Storage::StorageFile> filesInFolder{
        co_await picturesLibrary.GetFilesAsync(Windows::Storage::Search::CommonFileQuery::OrderByDate, 0, 20) };

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

// Get user's pictures library
StorageFolder^ picturesLibrary = KnownFolders::PicturesLibrary;

// Get the first 20 sorted images in the library
create_task(picturesLibrary->GetFilesAsync(CommonFileQuery::OrderByDate,0,20)).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」トピックの「解説」を参照してください。

次の表に、ファイルの一覧を取得する StorageFolder クラスのメソッドの一覧を示します。 テーブルは、現在のフォルダーからのファイルのみを返すシャロー クエリと、現在のフォルダーとそのサブフォルダーからファイルを返すディープ クエリを識別します。

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

ライブラリ フォルダーではないフォルダーから詳細なクエリ結果を取得するには、CreateFileQueryWithOptions(QueryOptions) メソッドを呼び出し、QueryOptions オブジェクトの FolderDepth プロパティの値として Deep を指定します。

こちらもご覧ください

• GetFilesAsync(CommonFileQuery, UInt32, UInt32)
• GetFilesAsync(CommonFileQuery)
• ファイル アクセス許可
• GetItemsAsync

public:
 virtual IAsyncOperation<IVectorView<StorageFile ^> ^> ^ GetFilesAsync(CommonFileQuery query) = GetFilesAsync;

/// [Windows.Foundation.Metadata.Overload("GetFilesAsyncOverloadDefaultStartAndCount")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery const& query);

[Windows.Foundation.Metadata.Overload("GetFilesAsyncOverloadDefaultStartAndCount")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query);

function getFilesAsync(query)

Public Function GetFilesAsync (query As CommonFileQuery) As IAsyncOperation(Of IReadOnlyList(Of StorageFile))

パラメーター

戻り値

このメソッドが正常に完了すると、クエリで指定されたとおりに並べ替えられたファイルのフラット リストが返 されます。 リストの種類は IReadOnlyList<StorageFile です>。 リスト内の各ファイルは、 StorageFile オブジェクトによって表されます。

実装

属性

OverloadAttribute RemoteAsyncAttribute

例外

こちらもご覧ください

• GetFilesAsync(CommonFileQuery, UInt32, UInt32)
• GetFilesAsync()
• ファイル アクセス許可
• GetItemsAsync

public:
 virtual IAsyncOperation<IVectorView<StorageFile ^> ^> ^ GetFilesAsync(CommonFileQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve) = GetFilesAsync;

/// [Windows.Foundation.Metadata.Overload("GetFilesAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorageFile>> GetFilesAsync(CommonFileQuery const& query, uint32_t const& startIndex, uint32_t const& maxItemsToRetrieve);

[Windows.Foundation.Metadata.Overload("GetFilesAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFile>> GetFilesAsync(CommonFileQuery query, uint startIndex, uint maxItemsToRetrieve);

function getFilesAsync(query, startIndex, maxItemsToRetrieve)

Public Function GetFilesAsync (query As CommonFileQuery, startIndex As UInteger, maxItemsToRetrieve As UInteger) As IAsyncOperation(Of IReadOnlyList(Of StorageFile))

パラメーター

戻り値

このメソッドが正常に完了すると、クエリで指定されたとおりに並べ替えられたファイルのフラット リストが返 されます。 リストの種類は IReadOnlyList<StorageFile です>。 リスト内の各ファイルは、 StorageFile オブジェクトによって表されます。

実装

属性

OverloadAttribute RemoteAsyncAttribute

例外

こちらもご覧ください

• GetFilesAsync(CommonFileQuery)
• GetFilesAsync()
• ファイル アクセス許可
• GetItemsAsync