Utiliser des fichiers

Cette rubrique décrit ce que vous devez savoir pour commencer la lecture et l’écriture dans des fichiers dans une application de plateforme Windows universelle (UWP). Les API et les types principaux sont présentés et des liens sont fournis pour vous aider à en savoir plus.

Il ne s’agit pas d’un didacticiel. Si vous souhaitez un didacticiel, consultez créer, écrire et lire un fichier qui, en plus de montrer comment créer, lire et écrire un fichier, explique comment utiliser des flux et des mémoires tampons. Vous pouvez également être intéressé par l’exemple d’accès aux fichiers qui montre comment créer, lire, écrire, copier et supprimer un fichier, mais aussi comment récupérer les propriétés de fichier et se souvenir d’un fichier ou d’un dossier afin que votre application puisse y accéder facilement à nouveau.

Nous allons étudier le code qui permet d’écrire et de lire du texte dans un fichier et comment accéder aux dossiers d’application locaux, itinérants et temporaires.

Ce que vous devez savoir

Voici les principaux types que vous devez connaître pour lire ou écrire du texte dans un fichier :

• Windows.Storage.StorageFile représente un fichier. Cette classe a des propriétés qui fournissent des informations sur le fichier et les méthodes de création, d’ouverture, de copie, de suppression et de modification du nom des fichiers. Vous pouvez être habitué à gérer des chemins d’accès en chaîne. Certaines API Windows Runtime utilisent un chemin en chaîne, mais le plus souvent, vous utiliserez un StorageFile pour représenter un fichier, car certains fichiers que vous utilisez dans UWP ne disposent pas d’un chemin ou ont un chemin parfois difficile à gérer. Utilisez StorageFile.GetFileFromPathAsync() pour convertir un chemin d’accès en chaîne en StorageFile.

• La classe FileIO offre un moyen simple pour lire et écrire du texte. Cette classe peut également lire/écrire un tableau d’octets ou le contenu d’une mémoire tampon. Cette classe est très similaire à la classe PathIO. La principale différence est qu’au lieu d’utiliser un chemin d’accès en chaîne, comme le fait PathIO, elle utilise un StorageFile.

• Windows.Storage.StorageFolder représente un dossier (répertoire). Cette classe dispose de méthodes pour la création de fichiers, l’interrogation du contenu d’un dossier, la création, la modification du nom et la suppression des dossiers, ainsi que de propriétés qui fournissent des informations sur un dossier.

Les méthodes courantes pour obtenir un StorageFolder sont notamment les suivantes :

• Windows.Storage.Pickers.FolderPicker qui permet à l’utilisateur de naviguer dans le dossier à utiliser.
• Windows.Storage.ApplicationData.Current qui fournit le StorageFolder spécifique de l’un des dossiers locaux à l’application comme le dossier local, itinérant et temporaire.
• Windows.Storage.KnownFolders qui fournit le StorageFolder pour les bibliothèques connues telles que les bibliothèques de musique ou d’images.

Écrire du texte dans un fichier

Pour cette introduction, nous allons nous concentrer sur un scénario simple : lecture et écriture de texte. Commençons par examiner un code qui utilise la classe FileIO pour écrire du texte dans un fichier.

Windows.Storage.StorageFolder storageFolder = Windows.Storage.ApplicationData.Current.LocalFolder;
Windows.Storage.StorageFile file = await storageFolder.CreateFileAsync("test.txt",
        Windows.Storage.CreationCollisionOption.OpenIfExists);

await Windows.Storage.FileIO.WriteTextAsync(file, "Example of writing a string\r\n");

// Append a list of strings, one per line, to the file
var listOfStrings = new List<string> { "line1", "line2", "line3" };
await Windows.Storage.FileIO.AppendLinesAsync(file, listOfStrings); // each entry in the list is written to the file on its own line.

Tout d’abord, nous identifions où le fichier doit être situé. Windows.Storage.ApplicationData.Current.LocalFolder fournit l’accès au dossier de données local, qui est créé pour votre application lors de son installation. Voir Accéder au système de fichiers pour plus d’informations sur les dossiers auxquels votre application peut accéder.

Ensuite, nous utilisons StorageFolder pour créer le fichier (ou l’ouvrir s’il existe déjà).

La classe FileIO fournit un moyen pratique d’écrire du texte dans le fichier. FileIO.WriteTextAsync() remplace l’ensemble du contenu du fichier par le texte fourni. FileIO.AppendLinesAsync() ajoute une collection de chaînes au fichier, en écrivant une seule chaîne par ligne.

Lire du texte dans un fichier

Pour la lecture d’un fichier comme pour l’écriture, il faut d’abord spécifier où se trouve le fichier. Nous allons utiliser le même emplacement, comme dans l’exemple ci-dessus. Ensuite, nous allons utiliser la classe FileIO pour lire son contenu.

Windows.Storage.StorageFolder storageFolder = Windows.Storage.ApplicationData.Current.LocalFolder;
Windows.Storage.StorageFile file = await storageFolder.GetFileAsync("test.txt");

string text = await Windows.Storage.FileIO.ReadTextAsync(file);

Vous pouvez également lire chaque ligne du fichier dans des chaînes individuelles dans une collection avec IList<string> contents = await Windows.Storage.FileIO.ReadLinesAsync(sampleFile);

Accéder au système de fichiers

Dans la plateforme UWP, l’accès au dossier est limité pour garantir l’intégrité et la confidentialité des données de l’utilisateur.

Dossiers d’application

Lorsqu’une application UWP est installée, plusieurs dossiers sont créés sous c:\users<nom de l’utilisateur>\AppData\Local\Packages<Identificateur du package de l’application>\ pour stocker, entre autres choses, les fichiers d’application locaux, itinérants et temporaires. L’application n’a pas besoin de déclarer de fonctionnalités pour accéder à ces dossiers, et ces dossiers ne sont pas accessibles par d’autres applications. Ces dossiers sont également supprimés lorsque l’application est désinstallée.

Voici quelques-uns des dossiers d’application que vous utilisez généralement :

• LocalState : pour les données locales sur l’appareil actuel. Lorsque l’appareil est sauvegardé, les données de ce répertoire sont enregistrées dans une image de sauvegarde dans OneDrive. Si l’utilisateur réinitialise ou remplace l’appareil, les données seront restaurées. Accédez à ce dossier avec Windows.Storage.ApplicationData.Current.LocalFolder. Enregistrez les données locales que vous ne voulez pas sauvegarder sur OneDrive dans le LocalCacheFolder auquel vous pouvez accéder avec Windows.Storage.ApplicationData.Current.LocalCacheFolder.

• RoamingState : les données stockées ici ne sont plus itinérantes (à partir de Windows 11), mais le dossier est toujours disponible. Accédez au dossier itinérant avec Windows.Storage.ApplicationData.Current.RoamingFolder. En remplacement, il est recommandé d’utiliser Azure App Service. Azure App Service est largement pris en charge, bien documenté, fiable et prend en charge les scénarios interplateformes/inter-écosystèmes comme iOS, Android et le web.

• TempState : pour les données qui peuvent être supprimées lorsque l’application n’est pas en cours d’exécution. Accédez à ce dossier avec Windows.Storage.ApplicationData.Current.TemporaryFolder.

Accédez au reste du système de fichiers

Une application UWP doit déclarer son intention d’accéder à une bibliothèque d’utilisateur spécifique en ajoutant la fonctionnalité correspondante dans son manifeste. L’utilisateur est alors invité lors de l’installation de l’application à vérifier qu’il autorise l’accès à la bibliothèque spécifiée. Si ce n’est pas le cas, l’application n’est pas installée. Il existe des fonctionnalités pour accéder aux bibliothèques de musique, de vidéos et d’images. Pour obtenir la liste complète, consultez Déclaration des fonctionnalités d’application. Pour obtenir un StorageFolder pour ces bibliothèques, utilisez la classe Windows.Storage.KnownFolders.

Bibliothèque de documents

Bien qu’il existe une fonctionnalité pour accéder à la bibliothèque de documents de l’utilisateur, cette fonctionnalité est limitée, ce qui signifie qu’une application qui la déclare est rejetée par le Microsoft Store, sauf si vous suivez un processus pour obtenir une approbation spéciale. Elle n’est pas destinée à être utilisée de manière générale. Au lieu de cela, utilisez les sélecteurs de fichiers ou de dossiers (voir Ouvrir des fichiers et dossiers à l’aide d’un sélecteur et Enregistrer un fichier avec un sélecteur) qui permettent à l’utilisateur de naviguer vers le fichier ou le dossier. Lorsque l’utilisateur navigue vers un fichier ou un dossier, il a donné implicitement l’autorisation à l’application d’y accéder et le système autorise l’accès.

Accès général

Sinon, votre application peut déclarer la fonctionnalité restreinte broadFileSystem dans son manifeste, ce qui requiert également l’approbation du Microsoft Store. L’application peut alors accéder à n’importe quel fichier auquel l’utilisateur a accès sans nécessiter l’intervention d’un sélecteur de fichier ou de dossier.

Pour obtenir la liste complète des emplacements auxquels les applications peuvent accéder, voir Autorisations d’accès aux fichiers.

API et documents utiles

Voici un résumé rapide des API et d’autres documents utiles pour vous aider à commencer à utiliser des fichiers et des dossiers.

API utiles

Documents utiles

Exemples de code utiles