CommonFileQuery Enumeração

Definição

Namespace:

Windows.Storage.Search

Especifica como classificar os arquivos nos resultados da consulta e determina se a consulta é superficial ou profunda. Os resultados da consulta para consultas profundas incluem todos os arquivos em todas as subpastas da pasta atual, classificadas de acordo com a opção especificada.

public enum class CommonFileQuery

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
enum class CommonFileQuery

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public enum CommonFileQuery

var value = Windows.Storage.Search.CommonFileQuery.defaultQuery

Public Enum CommonFileQuery

Herança

Enum

CommonFileQuery

Atributos

ContractVersionAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Campos

DefaultQuery	0	Uma lista superficial de arquivos na pasta atual, semelhante à lista que Explorador de Arquivos fornece. Você pode usar essa opção para qualquer local de armazenamento.
OrderByDate	5	Uma lista profunda e simples de arquivos em uma pasta e suas subpastas, classificadas por System.ItemDate. Você pode usar essa opção somente para pastas em uma biblioteca ou na pasta HomeGroup. Observação System.ItemDate é uma propriedade computada que muda com base no tipo de conteúdo; por exemplo, ele é mapeado para System.Photo.DateTaken para fotos.
OrderByMusicProperties	3	Uma lista profunda e simples de arquivos em uma pasta e suas subpastas, classificadas por propriedades de música. Você pode usar essa opção somente para pastas em uma biblioteca ou na pasta HomeGroup.
OrderByName	1	Uma lista profunda e simples de arquivos em uma pasta e suas subpastas, classificadas por System.ItemNameDisplay. Você pode usar essa opção para qualquer local de armazenamento.
OrderBySearchRank	4	Uma lista profunda e simples de arquivos em uma pasta e suas subpastas, classificadas por System.Search.Rank seguida por System.DateModified. Você pode usar essa opção para qualquer local de armazenamento.
OrderByTitle	2	Uma lista profunda e simples de arquivos em uma pasta e suas subpastas, classificadas por System.Title. Você pode usar essa opção somente para pastas em uma biblioteca ou na pasta HomeGroup.

Comentários

Use um valor da enumeração CommonFileQuery ao chamar um dos métodos a seguir da classe StorageFolder . Para obter exemplos que usam valores da enumeração CommonFileQuery, consulte os tópicos para esses métodos.

• CreateFileQuery(CommonFileQuery)
• CreateFileQueryWithOptions. Instancie o QueryOptions com o construtor QueryOptions(CommonFileQuery, IIterable(String) ).
• CreateItemQueryWithOptions. Instancie o QueryOptions com o construtor QueryOptions(CommonFileQuery, IIterable(String) ).
• GetFilesAsync(CommonFileQuery)
• GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Esses métodos usam o valor da enumeração CommonFileQuery para inicializar as opções FolderDepth, IndexerOption e SortOrder da consulta.

Chame o método StorageFolder.IsCommonFileQuerySupported para determinar se o valor CommonFileQuery que você deseja usar está disponível para a pasta atual.

Dica

Arquivos que não têm um valor para a propriedade que a consulta usa para classificar arquivos normalmente são excluídos dos resultados da consulta.

Confira também

• Exemplo de enumeração de pasta (Windows 10)