StorageFolder.GetFoldersAsync 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

GetFoldersAsync()	Obtém as subpastas na pasta atual.
GetFoldersAsync(CommonFolderQuery)	Obtém as subpastas na pasta atual. Quando o valor do argumento de consulta é algo diferente de CommonFolderQuery.DefaultQuery, obtém uma lista de pastas virtuais que representam contêineres para grupos de arquivos nas subpastas da pasta atual. Os arquivos são agrupados em pastas com base no valor especificado da enumeração CommonFolderQuery .
GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)	Obtém um intervalo de pastas baseado em índice da lista de todas as subpastas na pasta atual. Quando o valor do argumento de consulta é algo diferente de CommonFolderQuery.DefaultQuery, obtém uma lista de pastas virtuais que representam contêineres para grupos de arquivos nas subpastas da pasta atual. Os arquivos são agrupados em pastas com base no valor especificado da enumeração CommonFolderQuery .

GetFoldersAsync()

Editar

Obtém as subpastas na pasta atual.

public:
 virtual IAsyncOperation<IVectorView<StorageFolder ^> ^> ^ GetFoldersAsync() = GetFoldersAsync;

/// [Windows.Foundation.Metadata.Overload("GetFoldersAsyncOverloadDefaultOptionsStartAndCount")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync();

[Windows.Foundation.Metadata.Overload("GetFoldersAsyncOverloadDefaultOptionsStartAndCount")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync();

function getFoldersAsync()

Public Function GetFoldersAsync () As IAsyncOperation(Of IReadOnlyList(Of StorageFolder))

Retornos

IAsyncOperation<IVectorView<StorageFolder>>

IAsyncOperation<IReadOnlyList<StorageFolder>>

Quando esse método for concluído com êxito, ele retornará uma lista das subpastas na pasta atual. A lista é do tipo IReadOnlyList<StorageFolder>. Cada pasta na lista é representada por um objeto StorageFolder .

Implementações

GetFoldersAsync()

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 das subpastas na pasta Imagens do usuário, agrupada por mês, chamando o método GetFoldersAsync(CommonFolderQuery, UInt32, UInt32). (Os arquivos da raiz da pasta atual não estão incluídos.) Este exemplo retorna um máximo de 4 pastas, começando com a pasta no índice 0. Como a opção CommonFolderQuery.GroupByMonth classifica as datas em ordem decrescente (ou seja, da mais nova para a mais antiga), este exemplo retorna pastas para os quatro meses mais recentes para os quais o usuário tem fotos. Cada pasta contém todas as fotos do usuário desse mês.

Antes de executar o exemplo a seguir, habilite o recurso 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 files in the subfolders of the user's Pictures folder,
// grouped by month. Get only the first 4 folders (months).
IReadOnlyList <StorageFolder> groupedItems = await picturesFolder.GetFoldersAsync(CommonFolderQuery.GroupByMonth, 0, 4);

// Iterate over the results and print the list of folders
// and files to the Visual Studio Output window.
foreach (StorageFolder folder in groupedItems)
{
    Debug.WriteLine(folder.Name);

    // To iterate over the files in each folder, uncomment the following lines. 
    // foreach(StorageFile file in await folder.GetFilesAsync())
    //    Debug.WriteLine(" " + file.Name);
}

IAsyncAction MainPage::ExampleCoroutineAsync()
{
    // Get the users's Pictures folder.
    // Enable the Pictures Library capability in the app manifest file.
    Windows::Storage::StorageFolder picturesFolder{ Windows::Storage::KnownFolders::PicturesLibrary() };

    // Get the files in the user's Pictures folder, grouped by month.
    // Get only the first 4 folders (months).
    Windows::Foundation::Collections::IVectorView<Windows::Storage::StorageFolder> itemsInFolder{
        co_await picturesFolder.GetFoldersAsync(Windows::Storage::Search::CommonFolderQuery::GroupByMonth, 0, 4) };

    // Iterate over the results, and print the list of file groups to the Visual Studio output window.
    for (StorageFolder const& itemInFolder : itemsInFolder)
    {
        std::wstring output{ itemInFolder.Name() };
        ::OutputDebugString(output.c_str());
    }
}

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

// Get the files in the user's Pictures folder, grouped by month.
// Get only the first 4 folders (months).
create_task(picturesFolder->GetFoldersAsync(CommonFolderQuery::GroupByMonth, 0, 4)).then([=](IVectorView<StorageFolder^>^ itemsInFolder) {
 //Iterate over the results and print the list of file groups
 // to the visual studio output window
 for (auto it = itemsInFolder->First(); it->HasCurrent; it->MoveNext())
 {
  StorageFolder^ file = it->Current;
  String^ output = file->Name + "\n";
  OutputDebugString(output->Begin());
 }
});

Comentários

Essa consulta é uma consulta superficial que retorna apenas subpastas na pasta atual.

A tabela a seguir lista os métodos da classe StorageFolder que obtêm uma lista de subpastas. A tabela identifica consultas superficial que retornam apenas subpastas da pasta atual e consultas profundas que retornam o conteúdo de subpastas aninhadas, agrupadas em pastas virtuais.

Alguns métodos recebem um valor da enumeração CommonFolderQuery .

Quando você usa a opção DefaultQuery com qualquer pasta, a consulta retorna uma lista de subpastas no sistema de arquivos.
Quando você usa uma opção diferente de DefaultQuery com uma pasta de biblioteca, a consulta retorna uma lista de pastas virtuais que representam contêineres para arquivos das subpastas da pasta atual. (Os arquivos da pasta atual não estão incluídos.) Os arquivos são agrupados em pastas virtuais com base no valor especificado da enumeração CommonFolderQuery . Por exemplo, se você especificar GroupByMonth, a consulta retornará uma lista de pastas virtuais, como July 2014, August 2014e September 2014.

Dica

Você pode usar a opção DefaultQuery com qualquer pasta; você pode usar as outras opções da enumeração CommonFolderQuery somente com pastas de biblioteca, como a biblioteca Imagens ou a pasta Homegroup.

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

Método	Criar uma consulta superficial que retorna apenas subpastas da pasta atual	Criar uma consulta profunda que retorna todas as subpastas aninhadas
GetFoldersAsync()	Comportamento padrão desse método.	N/D
GetFoldersAsync(CommonFileQuery)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
GetFoldersAsync(CommonFileQuery, UInt32, UInt32)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
CreateFolderQuery()	Comportamento padrão desse método.	N/D
CreateFolderQuery(CommonFileQuery)	Especifique a opção DefaultQuery .	Para uma pasta de biblioteca, especifique uma opção diferente de DefaultQuery.
CreateFolderQueryWithOptions(QueryOptions)	Comportamento padrão desse método se nenhuma das opções a seguir for especificada. - ou - Especifique DefaultQuery como o valor de CommonFolderQuery 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 CommonFolderQuery quando você instanciar o objeto QueryOptions . - ou - Para qualquer pasta, especifique Deep como o valor da propriedade FolderDepth do QueryOptions.

Confira também

Aplica-se a

GetFoldersAsync(CommonFolderQuery)

Editar

Obtém as subpastas na pasta atual. Quando o valor do argumento de consulta é algo diferente de CommonFolderQuery.DefaultQuery, obtém uma lista de pastas virtuais que representam contêineres para grupos de arquivos nas subpastas da pasta atual. Os arquivos são agrupados em pastas com base no valor especificado da enumeração CommonFolderQuery .

public:
 virtual IAsyncOperation<IVectorView<StorageFolder ^> ^> ^ GetFoldersAsync(CommonFolderQuery query) = GetFoldersAsync;

/// [Windows.Foundation.Metadata.Overload("GetFoldersAsyncOverloadDefaultStartAndCount")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<IVectorView<StorageFolder>> GetFoldersAsync(CommonFolderQuery const& query);

[Windows.Foundation.Metadata.Overload("GetFoldersAsyncOverloadDefaultStartAndCount")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query);

function getFoldersAsync(query)

Public Function GetFoldersAsync (query As CommonFolderQuery) As IAsyncOperation(Of IReadOnlyList(Of StorageFolder))

Parâmetros

query: CommonFolderQuery

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

Retornos

IAsyncOperation<IVectorView<StorageFolder>>

IAsyncOperation<IReadOnlyList<StorageFolder>>

Quando esse método for concluído com êxito, ele retornará uma lista de subpastas. Quando o valor do argumento de consulta é algo diferente de CommonFolderQuery.DefaultQuery, esse método retorna uma lista de pastas virtuais que representam contêineres para grupos de arquivos nas subpastas da pasta atual. (Os arquivos da pasta atual não estão incluídos.) Os arquivos são agrupados conforme especificado pela consulta. A lista é do tipo IReadOnlyList<StorageFolder>. Cada pasta na lista é representada por um objeto StorageFolder .

Implementações

GetFoldersAsync(CommonFolderQuery)

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

GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Editar

Obtém um intervalo de pastas baseado em índice da lista de todas as subpastas na pasta atual. Quando o valor do argumento de consulta é algo diferente de CommonFolderQuery.DefaultQuery, obtém uma lista de pastas virtuais que representam contêineres para grupos de arquivos nas subpastas da pasta atual. Os arquivos são agrupados em pastas com base no valor especificado da enumeração CommonFolderQuery .

public:
 virtual IAsyncOperation<IVectorView<StorageFolder ^> ^> ^ GetFoldersAsync(CommonFolderQuery query, unsigned int startIndex, unsigned int maxItemsToRetrieve) = GetFoldersAsync;

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

[Windows.Foundation.Metadata.Overload("GetFoldersAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<IReadOnlyList<StorageFolder>> GetFoldersAsync(CommonFolderQuery query, uint startIndex, uint maxItemsToRetrieve);

function getFoldersAsync(query, startIndex, maxItemsToRetrieve)

Public Function GetFoldersAsync (query As CommonFolderQuery, startIndex As UInteger, maxItemsToRetrieve As UInteger) As IAsyncOperation(Of IReadOnlyList(Of StorageFolder))

Parâmetros

query: CommonFolderQuery

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

startIndex: UInt32
unsigned int

uint32_t

O índice baseado em zero da primeira pasta no intervalo a ser recuperado.

maxItemsToRetrieve: UInt32
unsigned int

uint32_t

O número máximo de pastas a serem recuperadas.

Retornos

IAsyncOperation<IVectorView<StorageFolder>>

IAsyncOperation<IReadOnlyList<StorageFolder>>

Implementações

M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,System.UInt32,System.UInt32) M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,unsigned int,unsigned int) M:Windows.Storage.Search.IStorageFolderQueryOperations.GetFoldersAsync(Windows.Storage.Search.CommonFolderQuery,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

StorageFolder.GetFoldersAsync Método

Definição

Sobrecargas

GetFoldersAsync()

Retornos

Implementações

Exceções

Exemplos

Comentários

Confira também

Aplica-se a

GetFoldersAsync(CommonFolderQuery)

Parâmetros

Retornos

Implementações

Exceções

Confira também

Aplica-se a

GetFoldersAsync(CommonFolderQuery, UInt32, UInt32)

Parâmetros

Retornos

Implementações

Exceções

Confira também

Aplica-se a

Comentários

Comentários

Recursos adicionais