CommonFileQuery Enumeración
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Especifica cómo ordenar los archivos en los resultados de la consulta y determina si la consulta es superficial o profunda. Los resultados de la consulta para consultas profundas incluyen todos los archivos de todas las subcarpetas de la carpeta actual, ordenadas según la opción 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
- Herencia
-
CommonFileQuery
- Atributos
Requisitos de Windows
Familia de dispositivos |
Windows 10 (se introdujo en la versión 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)
|
Campos
DefaultQuery | 0 | Una lista superficial de archivos en la carpeta actual, similar a la lista que proporciona Explorador de archivos. Puede usar esta opción para cualquier ubicación de almacenamiento. |
OrderByDate | 5 | Una lista profunda y plana de archivos en una carpeta y sus subcarpetas, ordenadas por System.ItemDate. Puede usar esta opción solo para carpetas de una biblioteca o la carpeta Grupo Hogar. Nota: System.ItemDate es una propiedad calculada que cambia en función del tipo de contenido; por ejemplo, se asigna a System.Photo.DateTaken para fotos. |
OrderByMusicProperties | 3 | Una lista profunda y plana de archivos en una carpeta y sus subcarpetas, ordenadas por propiedades de música. Puede usar esta opción solo para carpetas de una biblioteca o la carpeta Grupo Hogar. |
OrderByName | 1 | Una lista profunda y plana de archivos en una carpeta y sus subcarpetas, ordenadas por System.ItemNameDisplay. Puede usar esta opción para cualquier ubicación de almacenamiento. |
OrderBySearchRank | 4 | Una lista profunda y plana de archivos en una carpeta y sus subcarpetas, ordenadas por System.Search.Rank seguidas de System.DateModified. Puede usar esta opción para cualquier ubicación de almacenamiento. |
OrderByTitle | 2 | Una lista profunda y plana de archivos en una carpeta y sus subcarpetas, ordenadas por System.Title. Puede usar esta opción solo para carpetas de una biblioteca o la carpeta Grupo Hogar. |
Comentarios
Use un valor de la enumeración CommonFileQuery cuando llame a uno de los métodos siguientes de la clase StorageFolder . Para obtener ejemplos que usan valores de la enumeración CommonFileQuery, consulte los temas de estos métodos.
- CreateFileQuery(CommonFileQuery)
- CreateFileQueryWithOptions. Cree una instancia de QueryOptions con el constructor QueryOptions(CommonFileQuery, IIterable(String)).
- CreateItemQueryWithOptions. Cree una instancia de QueryOptions con el constructor QueryOptions(CommonFileQuery, IIterable(String)).
- GetFilesAsync(CommonFileQuery)
- GetFilesAsync(CommonFileQuery, UInt32, UInt32)
Estos métodos usan el valor de la enumeración CommonFileQuery para inicializar las opciones FolderDepth, IndexerOption y SortOrder de la consulta.
Llame al método StorageFolder.IsCommonFileQuerySupported para determinar si el valor de CommonFileQuery que desea usar está disponible para la carpeta actual.
Sugerencia
Los archivos que no tienen un valor para la propiedad que usa la consulta para ordenar los archivos normalmente se excluyen de los resultados de la consulta.