StorageFolder.GetFilesAsync Método

Referência

Definição

Namespace:: Windows.Storage

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

GetFilesAsync()	Obtém os arquivos na pasta atual.
GetFilesAsync(CommonFileQuery)	Obtém os arquivos na pasta atual. Também obtém os arquivos das subpastas da pasta atual quando o valor do argumento de consulta é algo diferente de CommonFileQuery.DefaultQuery. Os arquivos são classificados com base no valor especificado da enumeração CommonFileQuery .
GetFilesAsync(CommonFileQuery, UInt32, UInt32)	Obtém um intervalo de arquivos baseado em índice da lista de todos os arquivos na pasta atual. Também obtém os arquivos das subpastas da pasta atual quando o valor do argumento de consulta é algo diferente de CommonFileQuery.DefaultQuery. Os arquivos são classificados com base no valor especificado da enumeração CommonFileQuery .

GetFilesAsync()

Editar

Obtém os arquivos na pasta atual.

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

Retornos

IAsyncOperation<IVectorView<StorageFile>>

IAsyncOperation<IReadOnlyList<StorageFile>>

Quando esse método for concluído com êxito, ele retornará uma lista dos arquivos na pasta atual. A lista é do tipo IReadOnlyList<StorageFile>. Cada arquivo na lista é representado por um objeto StorageFile .

Implementações

GetFilesAsync()

Atributos: OverloadAttribute RemoteAsyncAttribute

Exceções

UnauthorizedAccessException

Você não tem permissão para acessar o conteúdo da pasta atual. Para obter mais informações, consulte Permissões de acesso a arquivos.

Exemplos

O exemplo a seguir mostra como obter o conteúdo da pasta Imagens do usuário e suas subpastas, classificadas por data, chamando o método sobrecarregado GetFilesAsync(CommonFileQuery, UInt32, UInt32). Este exemplo retorna um máximo de 20 arquivos, começando com o arquivo no índice 0. Como a opção CommonFileQuery.OrderByDate classifica as datas em ordem decrescente (ou seja, do mais recente para o mais antigo), este exemplo retorna as 20 fotos mais recentes do usuário.

Antes de executar o exemplo a seguir, habilite a funcionalidade Biblioteca de Imagens no arquivo de manifesto do aplicativo.

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

Comentários

Essa consulta é uma consulta superficial que retorna apenas arquivos na pasta atual. Para obter uma lista de métodos que identifica consultas superficiais e consultas profundas, consulte os Comentários no tópico GetFilesAsync.

A tabela a seguir lista os métodos da classe StorageFolder que obtêm uma lista de arquivos. A tabela identifica consultas superficial que retornam apenas arquivos da pasta atual e consultas profundas que retornam arquivos da pasta atual e de suas subpastas.

Alguns métodos recebem um valor da enumeração CommonFileQuery . Quando você especifica a opção DefaultQuery da enumeração CommonFileQuery , a consulta é uma consulta superficial que retorna apenas arquivos na pasta atual. Quando você especifica outro valor da enumeração CommonFileQuery , a consulta é uma consulta profunda que retorna uma lista nivelada de arquivos da pasta atual e de suas subpastas.

Dica

Alguns dos valores da enumeração CommonFileQuery só podem ser usados com uma pasta de biblioteca (como a biblioteca Imagens) ou a pasta Grupo Doméstico. Além da opção DefaultQuery , você pode usar apenas as opções OrderByName e OrderBySearchRank com uma pasta que não é uma pasta de biblioteca.

Para obter resultados de consultas profundas de uma pasta que não é uma pasta de biblioteca, chame o método CreateFileQueryWithOptions(QueryOptions) e especifiqueDeep como o valor da propriedade FolderDepth do objeto QueryOptions .

Método	Criar uma consulta superficial que retorna apenas arquivos da pasta atual	Criar uma consulta profunda que retorna arquivos da pasta atual e de suas subpastas
GetFilesAsync()	Comportamento padrão desse método.	N/D
GetFilesAsync(CommonFileQuery)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
GetFilesAsync(CommonFileQuery, UInt32, UInt32)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
CreateFileQuery()	Comportamento padrão desse método.	N/D
CreateFileQuery(CommonFileQuery)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
CreateFileQueryWithOptions(QueryOptions)	Comportamento padrão desse método se nenhuma das opções a seguir for especificada. - ou - Especifique DefaultQuery como o valor de CommonFileQuery ao instanciar o objeto QueryOptions . - ou - Especifique Shallow como o valor da propriedade FolderDepth do objeto QueryOptions .	Para uma pasta de biblioteca, especifique um valor diferente de DefaultQuery como o valor de CommonFileQuery ao instanciar o objeto QueryOptions . - ou - Para qualquer pasta, especifique Deep como o valor da propriedade FolderDepth do QueryOptions.

Confira também

Aplica-se a

GetFilesAsync(CommonFileQuery)

Editar

Obtém os arquivos na pasta atual. Também obtém os arquivos das subpastas da pasta atual quando o valor do argumento de consulta é algo diferente de CommonFileQuery.DefaultQuery. Os arquivos são classificados com base no valor especificado da enumeração CommonFileQuery .

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

Parâmetros

query: CommonFileQuery

Um dos valores de enumeração que especifica como classificar os arquivos e determina se a consulta é superficial ou profunda.

Retornos

IAsyncOperation<IVectorView<StorageFile>>

IAsyncOperation<IReadOnlyList<StorageFile>>

Quando esse método for concluído com êxito, ele retornará uma lista simples de arquivos, classificada conforme especificado pela consulta. A lista é do tipo IReadOnlyList<StorageFile>. Cada arquivo na lista é representado por um objeto StorageFile .

Implementações

GetFilesAsync(CommonFileQuery)

Atributos: OverloadAttribute RemoteAsyncAttribute

Exceções

UnauthorizedAccessException

Você não tem permissão para acessar o conteúdo da pasta atual. Para obter mais informações, consulte Permissões de acesso a arquivos.

Confira também

Aplica-se a

GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Editar

Obtém um intervalo de arquivos baseado em índice da lista de todos os arquivos na pasta atual. Também obtém os arquivos das subpastas da pasta atual quando o valor do argumento de consulta é algo diferente de CommonFileQuery.DefaultQuery. Os arquivos são classificados com base no valor especificado da enumeração CommonFileQuery .

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

Parâmetros

query: CommonFileQuery

Um dos valores de enumeração que especifica como classificar os arquivos e determina se a consulta é superficial ou profunda.

startIndex: UInt32
unsigned int

uint32_t

O índice baseado em zero do primeiro arquivo no intervalo a ser recuperado.

maxItemsToRetrieve: UInt32
unsigned int

uint32_t

O número máximo de arquivos a serem recuperados.

Retornos

IAsyncOperation<IVectorView<StorageFile>>

IAsyncOperation<IReadOnlyList<StorageFile>>

Quando esse método for concluído com êxito, ele retornará uma lista simples de arquivos classificados conforme especificado pela consulta. A lista é do tipo IReadOnlyList<StorageFile>. Cada arquivo na lista é representado por um objeto StorageFile .

Implementações

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)

Atributos: OverloadAttribute RemoteAsyncAttribute

Exceções

UnauthorizedAccessException

Você não tem permissão para acessar o conteúdo da pasta atual. Para obter mais informações, consulte Permissões de acesso a arquivos.

Confira também

Aplica-se a

Partilhar via

StorageFolder.GetFilesAsync Método

Definição

Sobrecargas

GetFilesAsync()

Retornos

Implementações

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

GetFilesAsync(CommonFileQuery)

Parâmetros

Retornos

Implementações

Exceções

Confira também

Aplica-se a

GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Parâmetros

Retornos

Implementações

Exceções

Confira também

Aplica-se a

Comentários

Recursos adicionais