CommonFileQuery Перечисление
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Указывает способ сортировки файлов в результатах запроса и определяет, является ли запрос неглубоким или глубоким. Результаты запроса для глубоких запросов включают все файлы во всех вложенных папках текущей папки, отсортированные по указанному параметру.
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
- Наследование
-
CommonFileQuery
- Атрибуты
Требования к Windows
Семейство устройств |
Windows 10 (появилось в 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (появилось в v1.0)
|
Поля
DefaultQuery | 0 | Неполный список файлов в текущей папке, аналогичный списку, который предоставляет проводник. Этот параметр можно использовать для любого расположения хранилища. |
OrderByDate | 5 | Глубокий плоский список файлов в папке и ее вложенных папках, отсортированный по System.ItemDate. Этот параметр можно использовать только для папок в библиотеке или папке Домашней группы. Примечание System.ItemDate — это вычисляемое свойство, которое изменяется в зависимости от типа контента; например, он сопоставляется с System.Photo.DateTaken для фотографий. |
OrderByMusicProperties | 3 | Глубокий плоский список файлов в папке и ее вложенных папках, отсортированный по свойствам музыки. Этот параметр можно использовать только для папок в библиотеке или папке Домашней группы. |
OrderByName | 1 | Глубокий, плоский список файлов в папке и ее вложенных папках, отсортированный по System.ItemNameDisplay. Этот параметр можно использовать для любого расположения хранилища. |
OrderBySearchRank | 4 | Глубокий, плоский список файлов в папке и ее вложенных папках, отсортированный по System.Search.Rank , а затем System.DateModified. Этот параметр можно использовать для любого расположения хранилища. |
OrderByTitle | 2 | Глубокий, плоский список файлов в папке и ее вложенных папках, отсортированный по System.Title. Этот параметр можно использовать только для папок в библиотеке или папке Домашней группы. |
Комментарии
Используйте значение из перечисления CommonFileQuery при вызове одного из следующих методов класса StorageFolder . Примеры использования значений из перечисления CommonFileQuery см. в разделах для этих методов.
- CreateFileQuery(CommonFileQuery)
- CreateFileQueryWithOptions. Создайте экземпляр QueryOptions с помощью конструктора QueryOptions(CommonFileQuery, IIterable(String) ).
- CreateItemQueryWithOptions. Создайте экземпляр QueryOptions с помощью конструктора QueryOptions(CommonFileQuery, IIterable(String) ).
- GetFilesAsync(CommonFileQuery)
- GetFilesAsync(CommonFileQuery, UInt32, UInt32)
Эти методы используют значение перечисления CommonFileQuery для инициализации параметров FolderDepth, IndexerOption и SortOrder запроса.
Вызовите метод StorageFolder.IsCommonFileQuerySupported , чтобы определить, доступно ли значение CommonFileQuery для текущей папки.
Совет
Файлы, не имеющие значения свойства, которое запрос использует для сортировки файлов, обычно исключаются из результатов запроса.