Freigeben über


StorageFolder.GetFilesAsync Methode

Definition

Überlädt

GetFilesAsync()

Ruft die Dateien im aktuellen Ordner ab.

GetFilesAsync(CommonFileQuery)

Ruft die Dateien im aktuellen Ordner ab. Ruft auch die Dateien aus den Unterordnern des aktuellen Ordners ab, wenn der Wert des Abfragearguments etwas anderes als CommonFileQuery.DefaultQuery ist. Dateien werden basierend auf dem angegebenen Wert aus der CommonFileQuery-Enumeration sortiert.

GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Ruft einen indexbasierten Bereich von Dateien aus der Liste aller Dateien im aktuellen Ordner ab. Ruft auch die Dateien aus den Unterordnern des aktuellen Ordners ab, wenn der Wert des Abfragearguments etwas anderes als CommonFileQuery.DefaultQuery ist. Dateien werden basierend auf dem angegebenen Wert aus der CommonFileQuery-Enumeration sortiert.

GetFilesAsync()

Ruft die Dateien im aktuellen Ordner ab.

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))

Gibt zurück

Wenn diese Methode erfolgreich abgeschlossen wurde, wird eine Liste der Dateien im aktuellen Ordner zurückgegeben. Die Liste ist vom Typ IReadOnlyList<StorageFile>. Jede Datei in der Liste wird durch ein StorageFile-Objekt dargestellt.

Implementiert

Attribute

Ausnahmen

Sie verfügen nicht über die Berechtigung, auf den Inhalt des aktuellen Ordners zuzugreifen. Weitere Informationen finden Sie unter Dateizugriffsberechtigungen.

Beispiele

Im folgenden Beispiel wird gezeigt, wie Sie den Inhalt des Ordners Bilder des Benutzers und seiner Unterordner nach Datum sortiert abrufen, indem Sie die überladene Methode GetFilesAsync(CommonFileQuery, UInt32, UInt32) aufrufen. In diesem Beispiel werden maximal 20 Dateien zurückgegeben, beginnend mit der Datei bei Index 0. Da die Option CommonFileQuery.OrderByDate Datumsangaben in absteigender Reihenfolge sortiert (d. h. von neuester zu ältester), gibt dieses Beispiel die 20 neuesten Fotos des Benutzers zurück.

Bevor Sie das folgende Beispiel ausführen, aktivieren Sie die Funktion Bilderbibliothek in der App-Manifestdatei.

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());
 }
});

Hinweise

Diese Abfrage ist eine flache Abfrage, die nur Dateien im aktuellen Ordner zurückgibt. Eine Liste der Methoden, die flache Abfragen und tiefe Abfragen identifizieren, finden Sie in den Anmerkungen im Thema GetFilesAsync.

In der folgenden Tabelle sind Methoden der StorageFolder-Klasse aufgeführt, die eine Liste von Dateien abrufen. Die Tabelle identifiziert flache Abfragen, die nur Dateien aus dem aktuellen Ordner zurückgeben, und tiefe Abfragen, die Dateien aus dem aktuellen Ordner und seinen Unterordnern zurückgeben.

Einige Methoden übernehmen einen Wert aus der CommonFileQuery-Enumeration . Wenn Sie die Option DefaultQuery aus der CommonFileQuery-Enumeration angeben, ist die Abfrage eine flache Abfrage, die nur Dateien im aktuellen Ordner zurückgibt. Wenn Sie einen anderen Wert aus der CommonFileQuery-Enumeration angeben, ist die Abfrage eine tiefe Abfrage, die eine abgeflachte Liste von Dateien aus dem aktuellen Ordner und seinen Unterordnern zurückgibt.

Tipp

Einige der Werte aus der CommonFileQuery-Enumeration können nur mit einem Bibliotheksordner (z. B. der Bildbibliothek) oder dem Ordner Heimnetzgruppe verwendet werden. Zusätzlich zur Option DefaultQuery können Sie nur die Optionen OrderByName und OrderBySearchRank mit einem Ordner verwenden, der kein Bibliotheksordner ist.

Um tiefe Abfrageergebnisse aus einem Ordner abzurufen, der kein Bibliotheksordner ist, rufen Sie die CreateFileQueryWithOptions(QueryOptions)- Methode auf, und geben Sie Deep als Wert der FolderDepth-Eigenschaft des QueryOptions-Objekts an.

Methode Erstellen einer flachen Abfrage, die nur Dateien aus dem aktuellen Ordner zurückgibt Erstellen einer tiefen Abfrage, die Dateien aus dem aktuellen Ordner und seinen Unterordnern zurückgibt
GetFilesAsync() Standardverhalten dieser Methode.
GetFilesAsync(CommonFileQuery) Geben Sie die Option DefaultQuery an . Geben Sie für einen Bibliotheksordner eine andere Option als DefaultQuery an.
GetFilesAsync(CommonFileQuery, UInt32, UInt32) Geben Sie die Option DefaultQuery an . Geben Sie für einen Bibliotheksordner eine andere Option als DefaultQuery an.
CreateFileQuery() Standardverhalten dieser Methode.
CreateFileQuery(CommonFileQuery) Geben Sie die Option DefaultQuery an . Geben Sie für einen Bibliotheksordner eine andere Option als DefaultQuery an.
CreateFileQueryWithOptions(QueryOptions) Standardverhalten dieser Methode, wenn keine der folgenden Optionen angegeben ist.
- oder -
Geben Sie DefaultQuery als Wert von CommonFileQuery an, wenn Sie das QueryOptions-Objekt instanziieren .
- oder -
Geben Sie Shallow als Wert der FolderDepth-Eigenschaft des QueryOptions-Objekts an.
Geben Sie für einen Bibliotheksordner einen anderen Wert als DefaultQuery als Wert von CommonFileQuery an, wenn Sie das QueryOptions-Objekt instanziieren .
- oder -
Geben Sie für jeden Ordner Deep als Wert der FolderDepth-Eigenschaft der QueryOptions-Eigenschaft an.

Weitere Informationen

Gilt für:

GetFilesAsync(CommonFileQuery)

Ruft die Dateien im aktuellen Ordner ab. Ruft auch die Dateien aus den Unterordnern des aktuellen Ordners ab, wenn der Wert des Abfragearguments etwas anderes als CommonFileQuery.DefaultQuery ist. Dateien werden basierend auf dem angegebenen Wert aus der CommonFileQuery-Enumeration sortiert.

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))

Parameter

query
CommonFileQuery

Einer der Enumerationswerte, der angibt, wie die Dateien sortiert werden sollen, und bestimmt, ob die Abfrage flach oder tief ist.

Gibt zurück

Wenn diese Methode erfolgreich abgeschlossen wurde, gibt sie eine flache Liste von Dateien zurück, die gemäß der Abfrage sortiert sind. Die Liste ist vom Typ IReadOnlyList<StorageFile>. Jede Datei in der Liste wird durch ein StorageFile-Objekt dargestellt.

Implementiert

Attribute

Ausnahmen

Sie verfügen nicht über die Berechtigung, auf den Inhalt des aktuellen Ordners zuzugreifen. Weitere Informationen finden Sie unter Dateizugriffsberechtigungen.

Weitere Informationen

Gilt für:

GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Ruft einen indexbasierten Bereich von Dateien aus der Liste aller Dateien im aktuellen Ordner ab. Ruft auch die Dateien aus den Unterordnern des aktuellen Ordners ab, wenn der Wert des Abfragearguments etwas anderes als CommonFileQuery.DefaultQuery ist. Dateien werden basierend auf dem angegebenen Wert aus der CommonFileQuery-Enumeration sortiert.

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))

Parameter

query
CommonFileQuery

Einer der Enumerationswerte, der angibt, wie die Dateien sortiert werden sollen, und bestimmt, ob die Abfrage flach oder tief ist.

startIndex
UInt32

unsigned int

uint32_t

Der nullbasierte Index der ersten Datei im abzurufenden Bereich.

maxItemsToRetrieve
UInt32

unsigned int

uint32_t

Die maximale Anzahl der abzurufenden Dateien.

Gibt zurück

Wenn diese Methode erfolgreich abgeschlossen wurde, gibt sie eine flache Liste von Dateien zurück, die gemäß der Abfrage sortiert sind. Die Liste ist vom Typ IReadOnlyList<StorageFile>. Jede Datei in der Liste wird durch ein StorageFile-Objekt dargestellt.

Implementiert

M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFilesAsync(Windows.Storage.Search.CommonFileQuery,System.UInt32,System.UInt32) M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFilesAsync(Windows.Storage.Search.CommonFileQuery,unsigned int,unsigned int) M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFilesAsync(Windows.Storage.Search.CommonFileQuery,uint32_t,uint32_t)
Attribute

Ausnahmen

Sie verfügen nicht über die Berechtigung, auf den Inhalt des aktuellen Ordners zuzugreifen. Weitere Informationen finden Sie unter Dateizugriffsberechtigungen.

Weitere Informationen

Gilt für: