Accès rapide aux propriétés de fichier dans UWP

  • Article

Découvrez comment récupérer rapidement une liste de fichiers et de leurs propriétés à partir d’une bibliothèque, et utiliser ces propriétés dans une application.  

Prérequis

  • Programmation asynchrone pour applications de plateforme universelle Windows (UWP) Vous pouvez apprendre à écrire des applications asynchrones en C# ou Visual Basic en lisant Appeler des API asynchrones en C# ou Visual Basic. Pour apprendre à écrire des applications asynchrones en C++, voir Programmation asynchrone en C++. 
  • Autorisations d’accès aux bibliothèques Le code de ces exemples nécessite la fonctionnalité picturesLibrary, mais votre emplacement de fichier peut avoir besoin d’une autre fonctionnalité, voire d’aucune. Pour en savoir plus, voir Autorisations d’accès aux fichiers. 
  • Énumération des fichiers simple Cet exemple utilise QueryOptions pour définir quelques propriétés avancées d’énumération. Pour en savoir plus sur l’obtention d’une simple liste de fichiers pour un petit répertoire, voir Énumérer et interroger des fichiers et dossiers. 

Utilisation

De nombreuses applications doivent répertorier les propriétés d’un groupe de fichiers, mais n’ont pas toujours besoin d’interagir directement avec ceux-ci. Par exemple, une application de musique lit (ouvre) un fichier à la fois, mais a besoin des propriétés de tous les fichiers d’un dossier pour pouvoir afficher la file d’attente des morceaux ou pour que l’utilisateur puisse choisir un fichier valide à lire.

Les exemples de cette page ne doivent pas être utilisés dans des applications qui modifient les métadonnées de chaque fichier ou application interagissant avec tous les StorageFiles résultants en plus de lire leurs propriétés. Pour plus d’informations, voir Énumérer et interroger des fichiers et dossiers. 

Énumérer toutes les images figurant dans un emplacement

Dans cet exemple, nous allons :

  • Créer un objet QueryOptions pour spécifier que l’application souhaite énumérer les fichiers aussi rapidement que possible.
  • Extraire les propriétés de fichier en paginant les objets StorageFile dans l’application. La pagination des fichiers réduit la mémoire utilisée par l’application et améliore sa réactivité perçue.

Création de la requête

Pour créer la requête, nous utilisons un objet QueryOptions pour spécifier que l’application ne s’intéresse à l’énumération que de certains types de fichiers d’images et pour filtrer les fichiers protégés par la Protection des informations Windows (System.Security.EncryptionOwners). 

Il est important de définir les propriétés auxquelles l’application va accéder à l’aide de QueryOptions.SetPropertyPrefetch. Si l’application accède à une propriété qui n’est pas prérécupérée, cela peut entraîner une dégradation significative des performances.

Le paramètre IndexerOption.OnlyUseIndexerAndOptimzeForIndexedProperties indique au système de renvoyer les résultats aussi rapidement que possible, mais d’inclure uniquement les propriétés spécifiées dans SetPropertyPrefetch.

Pagination dans les résultats

Les utilisateurs pouvant avoir des milliers ou millions de fichiers dans leur bibliothèque d’images, l’appel de GetFilesAsync surchargerait leur ordinateur, car il crée un StorageFile pour chaque image. Cela peut être résolu en créant un nombre fixe de StorageFiles et en les traitant dans l’interface utilisateur, ce qui libère la mémoire. 

Dans notre exemple, nous le faisons à l’aide de StorageFileQueryResult.GetFilesAsync(UInt32 StartIndex, UInt32 maxNumberOfItems) pour extraire uniquement 100 fichiers à la fois. L’application traite ensuite les fichiers et autorise le système d’exploitation à libérer cette mémoire par la suite. Cette technique plafonne la mémoire maximale de l’application et garantit que le système reste réactif. Bien entendu, vous devez ajuster le nombre de fichiers retournés pour votre scénario mais, pour garantir une expérience réactive pour tous les utilisateurs, il est recommandé de ne pas extraire plus de 500 fichiers à la fois.

Exemple  

StorageFolder folderToEnumerate = KnownFolders.PicturesLibrary; 
// Check if the folder is indexed before doing anything. 
IndexedState folderIndexedState = await folderToEnumerate.GetIndexedStateAsync(); 
if (folderIndexedState == IndexedState.NotIndexed || folderIndexedState == IndexedState.Unknown) 
{ 
    // Only possible in indexed directories.  
    return; 
} 
 
QueryOptions picturesQuery = new QueryOptions() 
{ 
    FolderDepth = FolderDepth.Deep, 
    // Filter out all files that have WIP enabled
    ApplicationSearchFilter = "System.Security.EncryptionOwners:[]", 
    IndexerOption = IndexerOption.OnlyUseIndexerAndOptimizeForIndexedProperties 
}; 

picturesQuery.FileTypeFilter.Add(".jpg"); 
string[] otherProperties = new string[] 
{ 
    SystemProperties.GPS.LatitudeDecimal, 
    SystemProperties.GPS.LongitudeDecimal 
}; 
 
picturesQuery.SetPropertyPrefetch(PropertyPrefetchOptions.BasicProperties | PropertyPrefetchOptions.ImageProperties, 
                                    otherProperties); 
SortEntry sortOrder = new SortEntry() 
{ 
    AscendingOrder = true, 
    PropertyName = "System.FileName" // FileName property is used as an example. Any property can be used here.  
}; 
picturesQuery.SortOrder.Add(sortOrder); 
 
// Create the query and get the results 
uint index = 0; 
const uint stepSize = 100; 
if (!folderToEnumerate.AreQueryOptionsSupported(picturesQuery)) 
{ 
    log("Querying for a sort order is not supported in this location"); 
    picturesQuery.SortOrder.Clear(); 
} 
StorageFileQueryResult queryResult = folderToEnumerate.CreateFileQueryWithOptions(picturesQuery); 
IReadOnlyList<StorageFile> images = await queryResult.GetFilesAsync(index, stepSize); 
while (images.Count != 0 || index < 10000) 
{ 
    foreach (StorageFile file in images) 
    { 
        // With the OnlyUseIndexerAndOptimizeForIndexedProperties set, this won't  
        // be async. It will run synchronously. 
        var imageProps = await file.Properties.GetImagePropertiesAsync(); 
 
        // Build the UI 
        log(String.Format("{0} at {1}, {2}", 
                    file.Path, 
                    imageProps.Latitude, 
                    imageProps.Longitude)); 
    } 
    index += stepSize; 
    images = await queryResult.GetFilesAsync(index, stepSize); 
} 

Résultats

Les fichiers StorageFile obtenus contiennent uniquement les propriétés demandées, mais sont renvoyés 10 fois plus rapidement par rapport aux autres IndexerOptions. L’application peut toujours demander l’accès aux propriétés non incluses dans la requête, mais cela implique une baisse des performances résultant de la nécessité d’ouvrir le fichier et d’extraire ces propriétés.  

Ajout de dossiers à des bibliothèques

Les applications peuvent demander à l’utilisateur d’ajouter l’emplacement à l’index à l’aide de StorageLibrary.RequestAddFolderAsync. Une fois l’emplacement inclus, il est automatiquement indexé et les applications peuvent utiliser cette technique pour énumérer les fichiers.  

Voir aussi

Référence API QueryOptions
Énumérer et interroger des fichiers et dossiers
Autorisations d’accès aux fichiers