StorageFile Classe

Définition

Représente un fichier. Fournit des informations sur le fichier et son contenu, ainsi que sur les moyens de les manipuler.

public ref class StorageFile sealed : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class StorageFile final : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class StorageFile : IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider
Public NotInheritable Class StorageFile
Implements IStorageFile, IStorageFile2, IStorageFilePropertiesWithAvailability, IStorageItem2, IStorageItemProperties2, IStorageItemPropertiesWithProvider
Héritage
Object Platform::Object IInspectable StorageFile
Attributs
Implémente

Configuration requise pour Windows

Famille d’appareils
Windows 10 (introduit dans 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduit dans v1.0)
Fonctionnalités de l’application
documentsLibrary musicLibrary picturesLibrary videosLibrary

Exemples

Cet exemple montre comment appeler un sélecteur de fichiers à l’aide de FileOpenPicker.PickSingleFileAsync pour capturer et traiter un fichier que les utilisateurs sélectionnent.

var openPicker = new FileOpenPicker();
StorageFile file = await openPicker.PickSingleFileAsync();
// Process picked file
if (file != null)
{
    // Store file for future access
    Windows.Storage.AccessCache.StorageApplicationPermissions.FutureAccessList.Add(file);
}
else
{
    // The user didn't pick a file
}

Une fois PickSingleFileAsync terminé, file obtient le fichier sélectionné en tant que StorageFile.

Dans l’exemple, openPicker contient un objet FileOpenPicker . Pour en savoir plus sur l’utilisation du sélecteur de fichiers, consultez Ouvrir des fichiers et des dossiers avec un sélecteur.

En outre, fileToken obtient un identificateur que vous pouvez utiliser pour récupérer le fichier à partir de FutureAccessList. Pour en savoir plus sur le stockage des fichiers et dossiers afin que vous puissiez y accéder à nouveau ultérieurement, consultez FutureAccessList, MostRecentlyUsedList et Suivi des fichiers et dossiers récemment utilisés.

Remarques

En règle générale, vous accédez aux objets StorageFile à la suite d’appels de méthode et/ou de fonction asynchrones. Par exemple, les deux méthodes statiques GetFileFromPathAsync et GetFileFromApplicationUriAsync retournent un StorageFile qui représente le fichier spécifié.

En outre, chaque fois que vous appelez un sélecteur de fichiers pour permettre à l’utilisateur de choisir un fichier (ou des fichiers), le sélecteur de fichiers retourne le fichier en tant que StorageFile.

Notes

Les objets StorageFile ne peuvent pas représenter des fichiers qui sont des types de fichiers « .lnk », « . url » ou « . wsh ».

Historique des versions

Version de Windows Version du SDK Valeur ajoutée
2004 19041 GetFileFromPathForUserAsync

Propriétés

Attributes

Obtient les attributs d’un fichier.

ContentType

Obtient le type MIME du contenu du fichier.

DateCreated

Obtient la date et l’heure de création du fichier actuel.

DisplayName

Obtient un nom convivial pour le fichier.

DisplayType

Obtient une description conviviale du type du fichier.

FileType

Obtient le type (extension de nom de fichier) du fichier.

FolderRelativeId

Obtient un identificateur pour le fichier. Cet ID est unique pour le résultat de la requête ou StorageFolder qui contient le fichier et peut être utilisé pour faire la distinction entre les éléments portant le même nom.

IsAvailable

Indique si le fichier est local, est mis en cache localement ou peut être téléchargé.

Name

Obtient le nom du fichier, y compris l’extension de nom de fichier.

Path

Obtient le chemin d’accès complet du système de fichiers du fichier actif, si le fichier a un chemin d’accès.

Properties

Obtient un objet qui fournit l’accès aux propriétés liées au contenu du fichier.

Provider

Obtient l’objet StorageProvider qui contient des informations sur le service qui stocke le fichier actuel.

Méthodes

CopyAndReplaceAsync(IStorageFile)

Remplace le fichier spécifié par une copie du fichier actif.

CopyAsync(IStorageFolder)

Crée une copie du fichier dans le dossier spécifié.

CopyAsync(IStorageFolder, String)

Crée une copie du fichier dans le dossier spécifié et renomme la copie.

CopyAsync(IStorageFolder, String, NameCollisionOption)

Crée une copie du fichier dans le dossier spécifié et renomme la copie. Cette méthode spécifie également ce qu’il faut faire si un fichier portant le même nom existe déjà dans le dossier de destination.

CreateStreamedFileAsync(String, StreamedFileDataRequestedHandler, IRandomAccessStreamReference)

Crée un StorageFile pour représenter le flux de données spécifié. Cette méthode permet à l’application de produire les données à la demande en spécifiant une fonction à appeler lorsque le StorageFile qui représente le flux est utilisé pour la première fois.

CreateStreamedFileFromUriAsync(String, Uri, IRandomAccessStreamReference)

Crée un StorageFile pour représenter un flux de données à partir de la ressource URI (Uniform Resource Identifier) spécifiée. Cette méthode permet à l’application de télécharger les données à la demande lors de la première consultation du StorageFile qui représente le flux.

DeleteAsync()

Supprime le fichier actif.

DeleteAsync(StorageDeleteOption)

Supprime le fichier actif, éventuellement en supprimant définitivement l’élément.

GetBasicPropertiesAsync()

Obtient les propriétés de base du fichier actif.

GetFileFromApplicationUriAsync(Uri)

Obtient un objet StorageFile pour représenter la ressource d’application URI (Uniform Resource Identifier) spécifiée. Pour obtenir des exemples d’URI d’exemples , consultez Charger des images et des ressources personnalisées pour la mise à l’échelle, le thème, le contraste élevé, etc.

GetFileFromPathAsync(String)

Obtient un objet StorageFile pour représenter le fichier au chemin spécifié.

GetFileFromPathForUserAsync(User, String)

Obtient un objet StorageFile basé sur un chemin absolu dans le système de fichiers pour un utilisateur donné.

GetParentAsync()

Obtient le dossier parent du fichier actif.

GetScaledImageAsThumbnailAsync(ThumbnailMode)

Obtient une image mise à l’échelle en tant que miniature, déterminée par l’objectif de la miniature.

GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32)

Obtient une image mise à l’échelle en tant que miniature, déterminée par l’objectif de la miniature et la taille demandée.

GetScaledImageAsThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Obtient une image mise à l’échelle en tant que miniature, déterminée par l’objectif de la miniature, la taille demandée et les options spécifiées

GetThumbnailAsync(ThumbnailMode)

Récupère une image miniature ajustée pour le fichier, déterminée par l’objectif de la miniature.

GetThumbnailAsync(ThumbnailMode, UInt32)

Récupère une image miniature ajustée pour le fichier, déterminée par l’objectif de la miniature et la taille demandée.

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Récupère une image miniature ajustée pour le fichier, déterminée par l’objectif de la miniature, la taille demandée et les options spécifiées.

IsEqual(IStorageItem)

Indique si le fichier actuel est égal au fichier spécifié.

IsOfType(StorageItemTypes)

Détermine si le StorageFile actuel correspond à la valeur StorageItemTypes spécifiée.

MoveAndReplaceAsync(IStorageFile)

Déplace le fichier actuel vers l’emplacement du fichier spécifié et remplace le fichier spécifié à cet emplacement.

MoveAsync(IStorageFolder)

Déplace le fichier actif vers le dossier spécifié.

MoveAsync(IStorageFolder, String)

Déplace le fichier actuel vers le dossier spécifié et renomme le fichier en fonction du nom souhaité.

MoveAsync(IStorageFolder, String, NameCollisionOption)

Déplace le fichier actuel vers le dossier spécifié et renomme le fichier en fonction du nom souhaité. Cette méthode spécifie également ce qu’il faut faire si un fichier portant le même nom existe déjà dans le dossier spécifié.

OpenAsync(FileAccessMode)

Ouvre un flux d’accès aléatoire avec les options spécifiées sur le fichier spécifié.

OpenAsync(FileAccessMode, StorageOpenOptions)

Ouvre un flux d’accès aléatoire avec les options spécifiées sur le fichier spécifié.

OpenReadAsync()

Ouvre un flux d’accès aléatoire sur le fichier actif pour la lecture du contenu du fichier.

OpenSequentialReadAsync()

Ouvre un flux d’accès séquentiel sur le fichier actif pour la lecture du contenu du fichier.

OpenTransactedWriteAsync()

Ouvre un flux d’accès aléatoire au fichier qui peut être utilisé pour les opérations d’écriture transactionnée.

OpenTransactedWriteAsync(StorageOpenOptions)

Ouvre un flux d’accès aléatoire au fichier qui peut être utilisé pour les opérations d’écriture transactionnée avec les options spécifiées.

RenameAsync(String)

Renomme le fichier actif.

RenameAsync(String, NameCollisionOption)

Renomme le fichier actif. Cette méthode spécifie également ce qu’il faut faire si un élément existant à l’emplacement du fichier actif porte le même nom.

ReplaceWithStreamedFileAsync(IStorageFile, StreamedFileDataRequestedHandler, IRandomAccessStreamReference)

Remplace le contenu du fichier auquel fait référence l’objet IStorageFile spécifié par un nouveau flux de données. Cette méthode permet à l’application de produire les données à la demande en spécifiant une fonction à appeler lorsque le StorageFile qui représente le flux est utilisé pour la première fois.

ReplaceWithStreamedFileFromUriAsync(IStorageFile, Uri, IRandomAccessStreamReference)

Remplace le contenu du fichier auquel fait référence l’objet IStorageFile spécifié par un nouveau flux de données de l’URI (Uniform Resource Identifier) spécifié. Cette méthode permet à l’application de télécharger les données à la demande lors de la première consultation du StorageFile qui représente le flux.

Le flux de données est accessible via le StorageFile retourné et les données sont téléchargées à la demande lors de la première consultation du StorageFile .

Remplace l’objet IStorageFile qui représente le fichier spécifié par un nouveau StorageFile qui fournit un flux de l’URI (Uniform Resource Identifier) spécifié.

S’applique à

Voir aussi