CommonFileQuery Énumération

Définition

Espace de noms:

Windows.Storage.Search

Spécifie comment trier les fichiers dans les résultats de la requête et détermine si la requête est superficielle ou profonde. Les résultats des requêtes pour les requêtes approfondies incluent tous les fichiers dans tous les sous-dossiers du dossier actif, triés selon l’option spécifiée.

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

Héritage

Enum

CommonFileQuery

Attributs

ContractVersionAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Champs

DefaultQuery	0	Liste superficielle de fichiers dans le dossier actif, similaire à la liste que Explorateur de fichiers fournit. Vous pouvez utiliser cette option pour n’importe quel emplacement de stockage.
OrderByDate	5	Liste complète et plate des fichiers d’un dossier et de ses sous-dossiers, triés par System.ItemDate. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel. Notes System.ItemDate est une propriété calculée qui change en fonction du type de contenu ; par exemple, il mappe à System.Photo.DateTaken pour les photos.
OrderByMusicProperties	3	Liste plate et approfondie des fichiers d’un dossier et de ses sous-dossiers, triés par propriétés musicales. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.
OrderByName	1	Liste complète et plate des fichiers d’un dossier et de ses sous-dossiers, triées par System.ItemNameDisplay. Vous pouvez utiliser cette option pour n’importe quel emplacement de stockage.
OrderBySearchRank	4	Liste plate et approfondie des fichiers d’un dossier et de ses sous-dossiers, triés par System.Search.Rank suivi de System.DateModified. Vous pouvez utiliser cette option pour n’importe quel emplacement de stockage.
OrderByTitle	2	Liste profonde et plate des fichiers d’un dossier et de ses sous-dossiers, triées par System.Title. Vous pouvez utiliser cette option uniquement pour les dossiers d’une bibliothèque ou du dossier Groupe résidentiel.

Remarques

Utilisez une valeur de l’énumération CommonFileQuery lorsque vous appelez l’une des méthodes suivantes de la classe StorageFolder . Pour obtenir des exemples qui utilisent des valeurs de l’énumération CommonFileQuery, consultez les rubriques de ces méthodes.

• CreateFileQuery(CommonFileQuery)
• CreateFileQueryWithOptions. Instanciez le QueryOptions avec le constructeur QueryOptions(CommonFileQuery, IIterable(String)).
• CreateItemQueryWithOptions. Instanciez le QueryOptions avec le constructeur QueryOptions(CommonFileQuery, IIterable(String)).
• GetFilesAsync(CommonFileQuery)
• GetFilesAsync(CommonFileQuery, UInt32, UInt32)

Ces méthodes utilisent la valeur de l’énumération CommonFileQuery pour initialiser les options FolderDepth, IndexerOption et SortOrder de la requête.

Appelez la méthode StorageFolder.IsCommonFileQuerySupported pour déterminer si la valeur CommonFileQuery que vous souhaitez utiliser est disponible pour le dossier actif.

Conseil

Les fichiers qui n’ont pas de valeur pour la propriété que la requête utilise pour trier les fichiers sont généralement exclus des résultats de la requête.

Voir aussi

• Exemple d’énumération de dossiers (Windows 10)