CreateFileW, fonction (fileapi.h)

Article
06/02/2023

Crée ou ouvre un fichier ou un appareil d’E/S. Les appareils d’E/S les plus couramment utilisés sont les suivants : fichier, flux de fichiers, répertoire, disque physique, volume, mémoire tampon de la console, lecteur de bande, ressource de communications, mailslot et canal. La fonction retourne un handle qui peut être utilisé pour accéder au fichier ou à l’appareil pour différents types d’E/S en fonction du fichier ou de l’appareil et des indicateurs et attributs spécifiés.

Pour effectuer cette opération en tant qu’opération transactionnelle, ce qui entraîne un handle qui peut être utilisé pour les E/S traitées, utilisez la fonction CreateFileTransacted.

Syntaxe

HANDLE CreateFileW(
  [in]           LPCWSTR               lpFileName,
  [in]           DWORD                 dwDesiredAccess,
  [in]           DWORD                 dwShareMode,
  [in, optional] LPSECURITY_ATTRIBUTES lpSecurityAttributes,
  [in]           DWORD                 dwCreationDisposition,
  [in]           DWORD                 dwFlagsAndAttributes,
  [in, optional] HANDLE                hTemplateFile
);

Paramètres

[in] lpFileName

Nom du fichier ou de l’appareil à créer ou ouvrir. Vous pouvez utiliser des barres obliques (/) ou des barres obliques inverses (\) dans ce nom.

Pour plus d’informations sur les noms d’appareils spéciaux, consultez Définition d’un nom d’appareil MS-DOS.

Pour créer un flux de fichiers, spécifiez le nom du fichier, un signe deux-points, puis le nom du flux. Pour plus d’informations, consultez flux de fichiers.

Par défaut, le nom est limité à MAX_PATH caractères. Pour étendre cette limite à 32 767 caractères larges, ajoutez « \\ ?\ » au chemin d’accès. Pour plus d’informations, consultez nommage des fichiers, des chemins d’accès et des espaces de noms.

Pourboire

À compter de Windows 10, version 1607, vous pouvez choisir de supprimer la limitation MAX_PATH sans précéder « \\ ?\ ». Pour plus d’informations, consultez la section « Limite maximale de longueur de chemin » de noms, fichiers, chemin s et espaces de noms.

[in] dwDesiredAccess

Accès demandé au fichier ou à l’appareil, qui peut être résumé sous forme de lecture, d’écriture, à la fois ou de zéro).

Les valeurs les plus couramment utilisées sont GENERIC_READ, GENERIC_WRITEou les deux (GENERIC_READ | GENERIC_WRITE). Pour plus d’informations, consultez des droits d’accès génériques, sécurité des fichiers et droits d’accès, constantes des droits d’accès aux fichierset ACCESS_MASK.

Si ce paramètre est égal à zéro, l’application peut interroger certaines métadonnées telles que des attributs de fichier, de répertoire ou d’appareil sans accéder à ce fichier ou appareil, même si GENERIC_READ'accès aurait été refusé.

Vous ne pouvez pas demander un mode d’accès qui est en conflit avec le mode de partage spécifié par le paramètre dwShareMode dans une demande ouverte qui a déjà un handle ouvert.

Pour plus d’informations, consultez la section Remarques de cette rubrique et Création et ouverture de fichiers.

[in] dwShareMode

Mode de partage demandé du fichier ou de l’appareil, qui peut être lu, écrit, à la fois, supprimer, tous ces éléments ou aucun (reportez-vous au tableau suivant). Les demandes d’accès aux attributs ou aux attributs étendus ne sont pas affectées par cet indicateur.

Si ce paramètre est égal à zéro et CreateFile réussit, le fichier ou l’appareil ne peut pas être partagé et ne peut pas être ouvert à nouveau tant que le handle du fichier ou de l’appareil n’est pas fermé. Pour plus d’informations, consultez la section Remarques.

Vous ne pouvez pas demander un mode de partage qui est en conflit avec le mode d’accès spécifié dans une requête existante qui a un handle ouvert. createFile échouerait et la fonction GetLastError retournerait ERROR_SHARING_VIOLATION.

Pour permettre à un processus de partager un fichier ou un appareil pendant qu’un autre processus a ouvert le fichier ou l’appareil, utilisez une combinaison compatible d’une ou plusieurs des valeurs suivantes. Pour plus d’informations sur les combinaisons valides de ce paramètre avec le paramètre dwDesiredAccess , consultez Création et ouverture de fichiers.

Remarque Les options de partage pour chaque handle ouvert restent en vigueur jusqu’à ce que ce handle soit fermé, quel que soit le contexte du processus.

Valeur	Signification
0 0x00000000	Empêche les opérations d’ouverture suivantes sur un fichier ou un appareil s’ils demandent la suppression, la lecture ou l’accès en écriture.
FILE_SHARE_DELETE 0x00000004	Active les opérations d’ouverture suivantes sur un fichier ou un appareil pour demander l’accès à la suppression. Sinon, aucun processus ne peut ouvrir le fichier ou l’appareil s’il demande la suppression de l’accès. Si cet indicateur n’est pas spécifié, mais que le fichier ou l’appareil a été ouvert pour supprimer l’accès, la fonction échoue. Remarque Supprimer l’accès autorise les opérations de suppression et de renommage.
FILE_SHARE_READ 0x00000001	Active les opérations d’ouverture suivantes sur un fichier ou un appareil pour demander l’accès en lecture. Sinon, aucun processus ne peut ouvrir le fichier ou l’appareil s’il demande l’accès en lecture. Si cet indicateur n’est pas spécifié, mais que le fichier ou l’appareil a été ouvert pour l’accès en lecture, la fonction échoue.
FILE_SHARE_WRITE 0x00000002	Active les opérations d’ouverture suivantes sur un fichier ou un appareil pour demander l’accès en écriture. Sinon, aucun processus ne peut ouvrir le fichier ou l’appareil s’il demande un accès en écriture. Si cet indicateur n’est pas spécifié, mais que le fichier ou l’appareil a été ouvert pour l’accès en écriture ou a un mappage de fichiers avec accès en écriture, la fonction échoue.

[in, optional] lpSecurityAttributes

Pointeur vers une structure SECURITY_ATTRIBUTES qui contient deux membres de données distincts mais connexes : un descripteur de sécurité facultatif et une valeur booléenne qui détermine si le handle retourné peut être hérité par les processus enfants.

Ce paramètre peut être NULL.

Si ce paramètre est NULL, le handle retourné par CreateFile ne peut pas être hérité par les processus enfants que l’application peut créer et le fichier ou l’appareil associé au handle retourné obtient un descripteur de sécurité par défaut.

Le lpSecurityDescriptor membre de la structure spécifie un SECURITY_DESCRIPTOR pour un fichier ou un appareil. Si ce membre est NULL, le fichier ou l’appareil associé au handle retourné est affecté à un descripteur de sécurité par défaut.

CreateFile ignore le membre lpSecurityDescriptor lors de l’ouverture d’un fichier ou d’un appareil existant, mais continue d’utiliser le membre bInheritHandle.

Le bInheritHandle membre de la structure spécifie si le handle retourné peut être hérité.

Pour plus d’informations, consultez la section Remarques.

[in] dwCreationDisposition

Action à entreprendre sur un fichier ou un appareil qui existe ou n’existe pas.

Pour les appareils autres que les fichiers, ce paramètre est généralement défini sur OPEN_EXISTING.

Pour plus d’informations, consultez la section Remarques.

Ce paramètre doit être l’une des valeurs suivantes, qui ne peuvent pas être combinées :

Valeur	Signification
CREATE_ALWAYS 2	Crée un fichier, toujours. Si le fichier spécifié existe et est accessible en écriture, la fonction tronque le fichier, la fonction réussit et le code de dernière erreur est défini sur ERROR_ALREADY_EXISTS (183). Si le fichier spécifié n’existe pas et qu’il s’agit d’un chemin d’accès valide, un nouveau fichier est créé, la fonction réussit et le code de dernière erreur est défini sur zéro. Pour plus d’informations, consultez la section Remarques de cette rubrique.
CREATE_NEW 1	Crée un fichier, uniquement s’il n’existe pas déjà. Si le fichier spécifié existe, la fonction échoue et le code de dernière erreur est défini sur ERROR_FILE_EXISTS (80). Si le fichier spécifié n’existe pas et qu’il s’agit d’un chemin d’accès valide à un emplacement accessible en écriture, un nouveau fichier est créé.
OPEN_ALWAYS 4	Ouvre un fichier, toujours. Si le fichier spécifié existe, la fonction réussit et le code de dernière erreur est défini sur ERROR_ALREADY_EXISTS (183). Si le fichier spécifié n’existe pas et qu’il s’agit d’un chemin d’accès valide à un emplacement accessible en écriture, la fonction crée un fichier et le code de dernière erreur est défini sur zéro.
OPEN_EXISTING 3	Ouvre un fichier ou un appareil, uniquement s’il existe. Si le fichier ou l’appareil spécifié n’existe pas, la fonction échoue et le code de dernière erreur est défini sur ERROR_FILE_NOT_FOUND (2). Pour plus d’informations sur les appareils, consultez la section Remarques.
TRUNCATE_EXISTING 5	Ouvre un fichier et la tronque afin que sa taille soit égale à zéro octet, uniquement s’il existe. Si le fichier spécifié n’existe pas, la fonction échoue et le code de dernière erreur est défini sur ERROR_FILE_NOT_FOUND (2). Le processus appelant doit ouvrir le fichier avec le jeu de bits GENERIC_WRITE dans le cadre du paramètre dwDesiredAccess.

[in] dwFlagsAndAttributes

Les attributs et indicateurs de fichier ou d’appareil, FILE_ATTRIBUTE_NORMAL étant la valeur par défaut la plus courante pour les fichiers.

Ce paramètre peut inclure n’importe quelle combinaison des attributs de fichier disponibles (FILE_ATTRIBUTE_*). Tous les autres attributs de fichier remplacent FILE_ATTRIBUTE_NORMAL.

Ce paramètre peut également contenir des combinaisons d’indicateurs (FILE_FLAG_) pour contrôler le comportement de mise en cache des fichiers ou des appareils, les modes d’accès et d’autres indicateurs à usage spécial. Ces valeurs s’associent à toutes les valeurs FILE_ATTRIBUTE_.

Ce paramètre peut également contenir des informations sqOS (Security Quality of Service) en spécifiant l’indicateur de SECURITY_SQOS_PRESENT. Des informations supplémentaires relatives aux indicateurs SQOS sont présentées dans le tableau suivant les tableaux d’attributs et d’indicateurs.

Remarque Lorsque CreateFile ouvre un fichier existant, il combine généralement les indicateurs de fichier avec les attributs de fichier du fichier existant et ignore tous les attributs de fichier fournis dans dwFlagsAndAttributes. Les cas spéciaux sont détaillés dans Création et ouverture de fichiers.

Certains des attributs et indicateurs de fichier suivants peuvent uniquement s’appliquer aux fichiers et pas nécessairement tous les autres types d’appareils qui CreateFile peuvent s’ouvrir. Pour plus d’informations, consultez la section Remarques de cette rubrique et Création et ouverture de fichiers.

Pour obtenir un accès plus avancé aux attributs de fichier, consultez SetFileAttributes. Pour obtenir la liste complète de tous les attributs de fichier avec leurs valeurs et descriptions, consultez constantes d’attributs de fichier.

Attribut	Signification
FILE_ATTRIBUTE_ARCHIVE 32 (0x20)	Le fichier doit être archivé. Les applications utilisent cet attribut pour marquer les fichiers à des fins de sauvegarde ou de suppression.
FILE_ATTRIBUTE_ENCRYPTED 16384 (0x4000)	Le fichier ou le répertoire est chiffré. Pour un fichier, cela signifie que toutes les données du fichier sont chiffrées. Pour un répertoire, cela signifie que le chiffrement est la valeur par défaut pour les fichiers et sous-répertoires nouvellement créés. Pour plus d’informations, consultez chiffrement de fichiers . Cet indicateur n’a aucun effet si FILE_ATTRIBUTE_SYSTEM est également spécifié. Cet indicateur n’est pas pris en charge sur les éditions Home, Home Premium, Starter ou ARM de Windows.
FILE_ATTRIBUTE_HIDDEN 2 (0x2)	Le fichier est masqué. Ne l’incluez pas dans une liste d’annuaires ordinaire.
FILE_ATTRIBUTE_NORMAL 128 (0x80)	Le fichier n’a pas d’autres attributs définis. Cet attribut est valide uniquement s’il est utilisé seul.
FILE_ATTRIBUTE_OFFLINE 4096 (0x1000)	Les données d’un fichier ne sont pas immédiatement disponibles. Cet attribut indique que les données de fichier sont physiquement déplacées vers le stockage hors connexion. Cet attribut est utilisé par le stockage distant, le logiciel de gestion de stockage hiérarchique. Les applications ne doivent pas modifier arbitrairement cet attribut.
FILE_ATTRIBUTE_READONLY 1 (0x1)	Le fichier est en lecture seule. Les applications peuvent lire le fichier, mais ne peuvent pas écrire ou supprimer le fichier.
FILE_ATTRIBUTE_SYSTEM 4 (0x4)	Le fichier fait partie ou est utilisé exclusivement par un système d’exploitation.
FILE_ATTRIBUTE_TEMPORARY 256 (0x100)	Le fichier est utilisé pour le stockage temporaire. Pour plus d’informations, consultez la section Comportement de mise en cache de cette rubrique.

Drapeau	Signification
FILE_FLAG_BACKUP_SEMANTICS 0x02000000	Le fichier est ouvert ou créé pour une opération de sauvegarde ou de restauration. Le système garantit que le processus appelant remplace les vérifications de sécurité des fichiers lorsque le processus a des privilèges SE_BACKUP_NAME et SE_RESTORE_NAME. Pour plus d’informations, consultez Modification des privilèges dans unde jeton. Vous devez définir cet indicateur pour obtenir un handle sur un répertoire. Un handle de répertoire peut être transmis à certaines fonctions au lieu d’un handle de fichier. Pour plus d’informations, consultez la section Remarques.
FILE_FLAG_DELETE_ON_CLOSE 0x04000000	Le fichier doit être supprimé immédiatement après la fermeture de tous ses handles, qui inclut le handle spécifié et tous les autres handles ouverts ou dupliqués. S’il existe des handles ouverts existants dans un fichier, l’appel échoue, sauf s’ils ont tous été ouverts avec le mode de partage FILE_SHARE_DELETE. Les demandes d’ouverture suivantes pour le fichier échouent, sauf si le mode de partage FILE_SHARE_DELETE est spécifié.
FILE_FLAG_NO_BUFFERING 0x20000000	Le fichier ou l’appareil est ouvert sans mise en cache système pour les lectures et écritures de données. Cet indicateur n’affecte pas la mise en cache de disque dur ou les fichiers mappés en mémoire. Il existe des exigences strictes pour l’utilisation des fichiers ouverts avec CreateFile à l’aide de l’indicateur de FILE_FLAG_NO_BUFFERING, pour plus d’informations, consultez de mise en mémoire tampon de fichiers.
FILE_FLAG_OPEN_NO_RECALL 0x00100000	Les données de fichier sont demandées, mais elles doivent continuer à se trouver dans le stockage distant. Il ne doit pas être transporté vers le stockage local. Cet indicateur est utilisé par les systèmes de stockage distants.
FILE_FLAG_OPEN_REPARSE_POINT 0x00200000	Le traitement normal point d’analyse ne se produit pas ; CreateFile tentera d’ouvrir le point d’analyse. Lorsqu’un fichier est ouvert, un handle de fichier est retourné, que le filtre qui contrôle le point d’analyse soit opérationnel ou non. Cet indicateur ne peut pas être utilisé avec l’indicateur CREATE_ALWAYS. Si le fichier n’est pas un point d’analyse, cet indicateur est ignoré. Pour plus d’informations, consultez la section Remarques.
FILE_FLAG_OVERLAPPED 0x40000000	Le fichier ou l’appareil est ouvert ou créé pour les E/S asynchrones. Lorsque les opérations d’E/S suivantes sont effectuées sur ce handle, l’événement spécifié dans la structure OVERLAPPED sera défini sur l’état signalé. Si cet indicateur est spécifié, le fichier peut être utilisé pour les opérations de lecture et d’écriture simultanées. Si cet indicateur n’est pas spécifié, les opérations d’E/S sont sérialisées, même si les appels aux fonctions de lecture et d’écriture spécifient une structure SE CHEVAUCHER. Pour plus d’informations sur les considérations relatives à l’utilisation d’un handle de fichier créé avec cet indicateur, consultez la section handles d’E/S synchrones et asynchrones de cette rubrique.
FILE_FLAG_POSIX_SEMANTICS 0x01000000	L’accès se produit en fonction des règles POSIX. Cela inclut l’autorisation de plusieurs fichiers avec des noms, qui diffèrent uniquement dans le cas, pour les systèmes de fichiers qui prennent en charge ce nom. Veillez à utiliser cette option, car les fichiers créés avec cet indicateur peuvent ne pas être accessibles par les applications écrites pour MS-DOS ou Windows 16 bits.
FILE_FLAG_RANDOM_ACCESS 0x10000000	L’accès est destiné à être aléatoire. Le système peut l’utiliser comme indicateur pour optimiser la mise en cache des fichiers. Cet indicateur n’a aucun effet si le système de fichiers ne prend pas en charge les E/S mises en cache et les FILE_FLAG_NO_BUFFERING. Pour plus d’informations, consultez la section Comportement de mise en cache de cette rubrique.
FILE_FLAG_SESSION_AWARE 0x00800000	Le fichier ou l’appareil est ouvert avec une prise en charge de session. Si cet indicateur n’est pas spécifié, les appareils par session (par exemple, un appareil utilisant la redirection USB RemoteFX) ne peuvent pas être ouverts par les processus s’exécutant dans la session 0. Cet indicateur n’a aucun effet pour les appelants qui ne sont pas dans la session 0. Cet indicateur est pris en charge uniquement sur les éditions serveur de Windows. Windows Server 2008 R2 et Windows Server 2008 : Cet indicateur n’est pas pris en charge avant Windows Server 2012.
FILE_FLAG_SEQUENTIAL_SCAN 0x08000000	L’accès est destiné à être séquentiel de début à fin. Le système peut l’utiliser comme indicateur pour optimiser la mise en cache des fichiers. Cet indicateur ne doit pas être utilisé si la lecture-behind (c’est-à-dire les analyses inversées) est utilisée. Cet indicateur n’a aucun effet si le système de fichiers ne prend pas en charge les E/S mises en cache et les FILE_FLAG_NO_BUFFERING. Pour plus d’informations, consultez la section Comportement de mise en cache de cette rubrique.
FILE_FLAG_WRITE_THROUGH 0x80000000	Les opérations d’écriture ne passent par aucun cache intermédiaire, elles vont directement sur le disque. Pour plus d’informations, consultez la section Comportement de mise en cache de cette rubrique.

Le paramètre dwFlagsAndAttributes peut également spécifier des informations SQOS. Pour plus d’informations, consultez niveaux d’emprunt d’identité. Lorsque l’application appelante spécifie l’indicateur SECURITY_SQOS_PRESENT dans dwFlagsAndAttributes, il peut également contenir une ou plusieurs des valeurs suivantes.

Indicateur de sécurité	Signification
SECURITY_ANONYMOUS	Emprunte l’identité d’un client au niveau de l’emprunt d’identité anonyme.
SECURITY_CONTEXT_TRACKING	Le mode de suivi de la sécurité est dynamique. Si cet indicateur n’est pas spécifié, le mode de suivi de la sécurité est statique.
SECURITY_DELEGATION	Emprunte l’identité d’un client au niveau de l’emprunt d’identité de délégation.
SECURITY_EFFECTIVE_ONLY	Seuls les aspects activés du contexte de sécurité du client sont disponibles pour le serveur. Si vous ne spécifiez pas cet indicateur, tous les aspects du contexte de sécurité du client sont disponibles. Cela permet au client de limiter les groupes et privilèges qu’un serveur peut utiliser lors de l’emprunt d’identité du client.
SECURITY_IDENTIFICATION	Emprunte l’identité d’un client au niveau de l’emprunt d’identité.
SECURITY_IMPERSONATION	Emprunt d’identité d’un client au niveau de l’emprunt d’identité. Il s’agit du comportement par défaut si aucun autre indicateur n’est spécifié avec l’indicateur SECURITY_SQOS_PRESENT.

[in, optional] hTemplateFile

Handle valide pour un fichier de modèle avec le droit d’accès GENERIC_READ. Le fichier de modèle fournit des attributs de fichier et des attributs étendus pour le fichier en cours de création.

Ce paramètre peut être NULL.

Lors de l’ouverture d’un fichier existant, CreateFile ignore ce paramètre.

Lors de l’ouverture d’un nouveau fichier chiffré, le fichier hérite de la liste de contrôle d’accès discrétionnaire de son répertoire parent. Pour plus d’informations, consultez chiffrement de fichiers .

Valeur de retour

Si la fonction réussit, la valeur de retour est un handle ouvert pour le fichier, l’appareil, le canal nommé ou l’emplacement de messagerie spécifié.

Si la fonction échoue, la valeur de retour est INVALID_HANDLE_VALUE. Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

CreateFile a été développé spécifiquement pour l’interaction des fichiers, mais a depuis été développé et amélioré pour inclure la plupart des autres types d’appareils et de mécanismes d’E/S disponibles pour les développeurs Windows. Cette section tente de couvrir les problèmes variés que les développeurs peuvent rencontrer lors de l’utilisation de createFile dans différents contextes et avec différents types d’E/S. Le texte tente d’utiliser le mot fichier uniquement lorsque vous faites référence spécifiquement aux données stockées dans un fichier réel sur un système de fichiers. Toutefois, certaines utilisations de fichier peuvent faire référence plus généralement à un objet d’E/S qui prend en charge des mécanismes de type fichier. Cette utilisation libérale du terme fichier est particulièrement répandue dans les noms constants et les noms de paramètres en raison des raisons historiques mentionnées précédemment.

Lorsqu’une application est terminée à l’aide du handle d’objet retourné par CreateFile, utilisez la fonction CloseHandle pour fermer le handle. Cela libère non seulement les ressources système, mais peut avoir une influence plus large sur les éléments tels que le partage du fichier ou de l’appareil et la validation des données sur le disque. Les détails sont notés dans cette rubrique selon les besoins.

Windows Server 2003 et Windows XP : Une violation de partage se produit si une tentative d’ouverture d’un fichier ou d’un répertoire pour suppression sur un ordinateur distant lorsque la valeur du paramètre dwDesiredAccess est l’indicateur d’accès DELETE (0x00010000) OR'ed with any other access flag, et le fichier ou le répertoire distant n’a pas été ouvert avec FILE_SHARE_DELETE. Pour éviter la violation de partage dans ce scénario, ouvrez le fichier ou le répertoire distant avec le droit d’accès DELETE uniquement, ou appelez DeleteFile sans ouvrir le fichier ou le répertoire pour suppression.

Certains systèmes de fichiers, tels que le système de fichiers NTFS, prennent en charge la compression ou le chiffrement des fichiers et répertoires individuels. Sur les volumes qui ont un système de fichiers monté avec cette prise en charge, un nouveau fichier hérite des attributs de compression et de chiffrement de son répertoire.

Vous ne pouvez pas utiliser CreateFile pour contrôler la compression, la décompression ou le déchiffrement sur un fichier ou un répertoire. Pour plus d’informations, consultez Création et ouverture de fichiers, compression et décompression de fichierset chiffrement de fichiers.

Windows Server 2003 et Windows XP : à des fins de compatibilité descendante, CreateFile n’applique pas de règles d’héritage lorsque vous spécifiez un descripteur de sécurité dans lpSecurityAttributes. Pour prendre en charge l’héritage, les fonctions qui interrogent ultérieurement le descripteur de sécurité de ce fichier peuvent déterminer et signaler de façon heuristique que l’héritage est en vigueur. Pour plus d’informations, consultez propagation automatique des AE héritantes.

Comme indiqué précédemment, si le paramètre lpSecurityAttributes est NULL, le handle retourné par CreateFile ne peut pas être hérité par les processus enfants que votre application peut créer. Les informations suivantes concernant ce paramètre s’appliquent également :

Si la variable membre bInheritHandle n’est pas FALSE, qui est n’importe quelle valeur différente de zéro, le handle peut être hérité. Par conséquent, il est essentiel que ce membre de structure soit correctement initialisé pour FALSE si vous n’avez pas l’intention que le handle soit hérité.
Les listes de contrôle d’accès (ACL) dans le descripteur de sécurité par défaut d’un fichier ou d’un répertoire sont héritées de son répertoire parent.
Le système de fichiers cible doit prendre en charge la sécurité sur les fichiers et les répertoires du membre lpSecurityDescriptor pour qu’il ait un effet sur eux, ce qui peut être déterminé à l’aide de GetVolumeInformation.

Dans Windows 8 et Windows Server 2012, cette fonction est prise en charge par les technologies suivantes.

Technologie	Supporté
Protocole SMB (Server Message Block) 3.0	Oui
Basculement transparent SMB 3.0 (TFO)	Voir les remarques
SMB 3.0 avec partages de fichiers avec montée en puissance parallèle (SO)	Voir les remarques
Cluster Shared Volume File System (CsvFS)	Oui
Système de fichiers résilient (ReFS)	Oui

Notez que CreateFile avec suppression de remplacement échoue si elle est effectuée sur un fichier où il existe déjà un autre flux de données ouvert.

comportement de lien symbolique

Si l’appel à cette fonction crée un fichier, aucun changement de comportement n’est apporté. Prenez également en compte les informations suivantes concernant FILE_FLAG_OPEN_REPARSE_POINT:

Si FILE_FLAG_OPEN_REPARSE_POINT est spécifié :
- Si un fichier existant est ouvert et qu’il s’agit d’un lien symbolique, le handle retourné est un handle vers le lien symbolique.
- Si TRUNCATE_EXISTING ou FILE_FLAG_DELETE_ON_CLOSE sont spécifiés, le fichier affecté est un lien symbolique.
Si FILE_FLAG_OPEN_REPARSE_POINT n’est pas spécifié :
- Si un fichier existant est ouvert et qu’il s’agit d’un lien symbolique, le handle retourné est un handle à la cible.
- Si CREATE_ALWAYS, TRUNCATE_EXISTINGou FILE_FLAG_DELETE_ON_CLOSE sont spécifiés, le fichier affecté est la cible.

comportement de mise en cache

Plusieurs des valeurs possibles pour le paramètre dwFlagsAndAttributes sont utilisées par CreateFile pour contrôler ou affecter la façon dont les données associées au handle sont mises en cache par le système. Elles sont les suivantes :

FILE_FLAG_NO_BUFFERING
FILE_FLAG_RANDOM_ACCESS
FILE_FLAG_SEQUENTIAL_SCAN
FILE_FLAG_WRITE_THROUGH
FILE_ATTRIBUTE_TEMPORARY

Si aucun de ces indicateurs n’est spécifié, le système utilise un schéma de mise en cache à usage général par défaut. Sinon, la mise en cache du système se comporte comme spécifié pour chaque indicateur.

Certains de ces indicateurs ne doivent pas être combinés. Par exemple, la combinaison de FILE_FLAG_RANDOM_ACCESS avec FILE_FLAG_SEQUENTIAL_SCAN est auto-défaite.

La spécification de l’indicateur FILE_FLAG_SEQUENTIAL_SCAN peut augmenter les performances des applications qui lisent des fichiers volumineux à l’aide d’un accès séquentiel. Les gains de performances peuvent être encore plus visibles pour les applications qui lisent les fichiers volumineux principalement de manière séquentielle, mais ignorent occasionnellement les petites plages d’octets. Si une application déplace le pointeur de fichier pour l’accès aléatoire, les performances de mise en cache optimales ne se produisent probablement pas. Toutefois, une opération correcte est toujours garantie.

Les indicateurs FILE_FLAG_WRITE_THROUGH et FILE_FLAG_NO_BUFFERING sont indépendants et peuvent être combinés.

Si FILE_FLAG_WRITE_THROUGH est utilisé mais que FILE_FLAG_NO_BUFFERING n’est pas également spécifié, de sorte que la mise en cache du système soit en vigueur, les données sont écrites dans le cache du système, mais sont vidées sur le disque sans délai.

Si FILE_FLAG_WRITE_THROUGH et FILE_FLAG_NO_BUFFERING sont tous les deux spécifiés, de sorte que la mise en cache du système n’est pas en vigueur, les données sont immédiatement vidées sur le disque sans passer par le cache du système Windows. Le système d’exploitation demande également une écriture du cache matériel local du disque dur sur un média persistant.

Remarque Le matériel de disque dur ne prend pas en charge cette fonctionnalité d’écriture.

L’utilisation appropriée de l’indicateur de FILE_FLAG_NO_BUFFERING nécessite des considérations particulières relatives à l’application. Pour plus d’informations, consultez de mise en mémoire tampon de fichiers .

Une requête en écriture via FILE_FLAG_WRITE_THROUGH entraîne également le vidage de toutes les modifications de métadonnées, telles qu’une mise à jour d’horodatage ou une opération de renommage, résultant du traitement de la demande. Pour cette raison, l’indicateur de FILE_FLAG_WRITE_THROUGH est souvent utilisé avec l’indicateur FILE_FLAG_NO_BUFFERING comme remplacement de l’appel de la fonction FlushFileBuffers après chaque écriture, ce qui peut entraîner des pénalités de performances inutiles. L’utilisation de ces indicateurs permet d’éviter ces pénalités. Pour obtenir des informations générales sur la mise en cache des fichiers et des métadonnées, consultez mise en cache des fichiers.

Lorsque FILE_FLAG_NO_BUFFERING est combinée à FILE_FLAG_OVERLAPPED, les indicateurs offrent des performances asynchrones maximales, car les E/S ne reposent pas sur les opérations synchrones du gestionnaire de mémoire. Toutefois, certaines opérations d’E/S prennent plus de temps, car les données ne sont pas conservées dans le cache. En outre, les métadonnées du fichier peuvent toujours être mises en cache (par exemple, lors de la création d’un fichier vide). Pour vous assurer que les métadonnées sont vidées sur le disque, utilisez la fonction FlushFileBuffers.

En spécifiant l’attribut FILE_ATTRIBUTE_TEMPORARY, les systèmes de fichiers évitent d’écrire des données dans le stockage en masse si une mémoire cache suffisante est disponible, car une application supprime un fichier temporaire une fois qu’un handle est fermé. Dans ce cas, le système peut tout à fait éviter d’écrire les données. Bien qu’il ne contrôle pas directement la mise en cache des données de la même façon que les indicateurs mentionnés précédemment, l’attribut FILE_ATTRIBUTE_TEMPORARY indique au système de contenir autant que possible dans le cache système sans écrire et peut donc être préoccupé par certaines applications.

fichiers

Si vous renommez ou supprimez un fichier, puis restaurez-le peu après, le système recherche dans le cache les informations de fichier à restaurer. Les informations mises en cache incluent sa paire de noms courte/longue et son heure de création.

Si vous appelez CreateFile sur un fichier en attente de suppression suite à un appel précédent à DeleteFile, la fonction échoue. Le système d’exploitation retarde la suppression du fichier jusqu’à ce que tous les handles du fichier soient fermés. GetLastError retourne ERROR_ACCESS_DENIED.

Le paramètre dwDesiredAccess peut être égal à zéro, ce qui permet à l’application d’interroger les attributs de fichier sans accéder au fichier si l’application s’exécute avec des paramètres de sécurité adéquats. Cela est utile pour tester l’existence d’un fichier sans l’ouvrir pour l’accès en lecture et/ou en écriture, ou pour obtenir d’autres statistiques sur le fichier ou le répertoire. Consultez obtenir et définir des informations de fichier et GetFileInformationByHandle.

Si CREATE_ALWAYS et FILE_ATTRIBUTE_NORMAL sont spécifiés, CreateFile échoue et définit la dernière erreur sur ERROR_ACCESS_DENIED si le fichier existe et a l’attribut FILE_ATTRIBUTE_HIDDEN ou FILE_ATTRIBUTE_SYSTEM. Pour éviter l’erreur, spécifiez les mêmes attributs que le fichier existant.

Lorsqu’une application crée un fichier sur un réseau, il est préférable d’utiliser GENERIC_READ | GENERIC_WRITE pour dwDesiredAccess que d’utiliser GENERIC_WRITE seul. Le code résultant est plus rapide, car le redirecteur peut utiliser le gestionnaire de cache et envoyer moins de PME avec plus de données. Cette combinaison évite également un problème où l’écriture dans un fichier sur un réseau peut parfois retourner ERROR_ACCESS_DENIED.

Pour plus d’informations, consultez Création et ouverture de fichiers.

handles d’E/S synchrones et asynchrones

CreateFile fournit la création d’un handle de fichier ou d’appareil synchrone ou asynchrone. Un handle synchrone se comporte de sorte que les appels de fonction d’E/S à l’aide de ce handle sont bloqués jusqu’à ce qu’ils se terminent, tandis qu’un handle de fichier asynchrone permet au système de retourner immédiatement à partir des appels de fonction d’E/S, qu’ils terminent l’opération d’E/S ou non. Comme indiqué précédemment, ce comportement synchrone et asynchrone est déterminé en spécifiant FILE_FLAG_OVERLAPPED dans le paramètre dwFlagsAndAttributes. Il existe plusieurs complexités et pièges potentiels lors de l’utilisation d’E/S asynchrones ; pour plus d’informations, consultez d’E/S synchrones et asynchrones.

flux de fichiers

Sur les systèmes de fichiers NTFS, vous pouvez utiliser CreateFile pour créer des flux distincts dans un fichier. Pour plus d’informations, consultez flux de fichiers.

répertoires

Une application ne peut pas créer un répertoire à l’aide de CreateFile, par conséquent, seule la valeur de OPEN_EXISTING est valide pour dwCreationDisposition pour ce cas d’usage. Pour créer un répertoire, l’application doit appeler CreateDirectory ou CreateDirectoryEx.

Pour ouvrir un répertoire à l’aide de CreateFile, spécifiez l’indicateur FILE_FLAG_BACKUP_SEMANTICS dans le cadre de dwFlagsAndAttributes. Les vérifications de sécurité appropriées s’appliquent quand cet indicateur est utilisé sans SE_BACKUP_NAME et SE_RESTORE_NAME privilèges.

Lorsque vous utilisez CreateFile pour ouvrir un répertoire lors de la défragmentation d’un volume de système de fichiers FAT ou FAT32, ne spécifiez pas le droit d’accès MAXIMUM_ALLOWED. L’accès au répertoire est refusé si c’est le cas. Spécifiez plutôt le droit d’accès GENERIC_READ.

Pour plus d’informations, consultez About Directory Management.

disques physiques et volumes

L’accès direct au disque ou à un volume est restreint.

Windows Server 2003 et Windows XP : l’accès direct au disque ou à un volume n’est pas limité de cette façon.

Vous pouvez utiliser la fonction CreateFile pour ouvrir un lecteur de disque physique ou un volume, qui retourne un handle DASD (Direct Access Storage Device Device) qui peut être utilisé avec la fonction DeviceIoControl. Cela vous permet d’accéder directement au disque ou au volume, par exemple des métadonnées de disque comme la table de partition. Toutefois, ce type d’accès expose également le lecteur de disque ou le volume à une perte de données potentielle, car une écriture incorrecte sur un disque à l’aide de ce mécanisme peut rendre son contenu inaccessible au système d’exploitation. Pour garantir l’intégrité des données, veillez à vous familiariser avec DeviceIoControl et à la façon dont d’autres API se comportent différemment avec un handle d’accès direct par opposition à un handle de système de fichiers.

Les conditions suivantes doivent être remplies pour qu’un tel appel réussisse :

L’appelant doit disposer de privilèges d’administration. Pour plus d’informations, consultez Exécution avec des privilèges spéciaux.
Le paramètre dwCreationDisposition doit avoir l’indicateur OPEN_EXISTING.
Lors de l’ouverture d’un volume ou d’un disque floppy, le paramètre dwShareMode doit avoir l’indicateur FILE_SHARE_WRITE.

Remarque Le paramètre dwDesiredAccess peut être égal à zéro, ce qui permet à l’application d’interroger des attributs d’appareil sans accéder à un appareil. Cela est utile pour une application pour déterminer la taille d’un lecteur de disque de floppy et les formats pris en charge sans nécessiter de disque de floppy dans un lecteur, par exemple. Il peut également être utilisé pour lire des statistiques sans nécessiter d’autorisation de lecture/écriture de données de niveau supérieur.

Lors de l’ouverture d’un lecteur physique x:, la chaîne lpFileName doit être la forme suivante : « \\.\PhysicalDriveX». Les numéros de disque dur commencent à zéro. Le tableau suivant présente quelques exemples de chaînes de lecteur physiques.

Corde	Signification
« \\.\PhysicalDrive0 »	Ouvre le premier lecteur physique.
« \\.\PhysicalDrive2 »	Ouvre le troisième lecteur physique.

Pour obtenir l’identificateur de lecteur physique d’un volume, ouvrez un handle sur le volume et appelez la fonction DeviceIoControl avec IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS. Ce code de contrôle retourne le numéro de disque et le décalage pour chacune des étendues du volume ; un volume peut s’étendre sur plusieurs disques physiques.

Pour obtenir un exemple d’ouverture d’un lecteur physique, consultez Appel de DeviceIoControl.

Lors de l’ouverture d’un volume ou d’un lecteur multimédia amovible (par exemple, un lecteur de disque floppy ou un lecteur de mémoire flash), la chaîne lpFileName doit être la forme suivante : « \\.\X: ». N’utilisez pas de barre oblique inverse de fin (\), qui indique le répertoire racine d’un lecteur. Le tableau suivant présente quelques exemples de chaînes de lecteur.

Corde	Signification
« \\.\A : »	Ouvre le lecteur de disque de floppy A.
« \\.\C : »	Ouvre le volume C : .
« \\.\C :\ »	Ouvre le système de fichiers du volume C : .

Vous pouvez également ouvrir un volume en faisant référence à son nom de volume. Pour plus d’informations, consultez Nommage d’un volume.

Un volume contient un ou plusieurs systèmes de fichiers montés. Les handles de volume peuvent être ouverts comme non mis en cache à la discrétion du système de fichiers particulier, même lorsque l’option non mise en cache n’est pas spécifiée dans CreateFile. Vous devez supposer que tous les systèmes de fichiers Microsoft ouvrent des handles de volume comme non mis en cache. Les restrictions sur les E/S non mises en cache pour les fichiers s’appliquent également aux volumes.

Un système de fichiers peut ou non nécessiter l’alignement de la mémoire tampon même si les données ne sont pas mises en cache. Toutefois, si l’option non mise en cache est spécifiée lors de l’ouverture d’un volume, l’alignement de la mémoire tampon est appliqué indépendamment du système de fichiers sur le volume. Il est recommandé sur tous les systèmes de fichiers que vous ouvrez des handles de volume comme non mis en cache et de suivre les restrictions d’E/S non mises en cache.

Remarque Pour lire ou écrire dans les derniers secteurs du volume, vous devez appeler DeviceIoControl et spécifier FSCTL_ALLOW_EXTENDED_DASD_IO. Cela signale au pilote du système de fichiers de ne pas effectuer de vérifications de limites d’E/S sur les appels de lecture ou d’écriture de partition. Au lieu de cela, les vérifications des limites sont effectuées par le pilote de périphérique.

Changer d’appareil

Les codes de contrôle IOCTL_CHANGER_* pour DeviceIoControl accepter un handle sur un appareil de changement. Pour ouvrir un appareil de changement, utilisez un nom de fichier du formulaire suivant : « \\.\Changerx» où x est un nombre qui indique l’appareil à ouvrir, en commençant par zéro. Pour ouvrir l’appareil de changement zéro dans une application écrite en C ou C++, utilisez le nom de fichier suivant : « \\\\.\\Changer0 ».

lecteurs de bande

Vous pouvez ouvrir des lecteurs de bande à l’aide d’un nom de fichier de la forme suivante : « \\.\TAPEx» où x est un nombre qui indique le lecteur à ouvrir, en commençant par le lecteur de bande zéro. Pour ouvrir le lecteur de bande zéro dans une application écrite en C ou C++, utilisez le nom de fichier suivant : « \\\\.\\\TAPE0 ».

Pour plus d’informations, consultez de sauvegarde .

ressources de communication

La fonction CreateFile peut créer un handle vers une ressource de communication, telle que le port série COM1. Pour les ressources de communication, le paramètre dwCreationDisposition doit être OPEN_EXISTING, le paramètre dwShareMode doit être zéro (accès exclusif) et le paramètre hTemplateFile doit être NULL. L’accès en lecture, écriture ou lecture/écriture peut être spécifié et le handle peut être ouvert pour les E/S superposées.

Pour spécifier un numéro de port COM supérieur à 9, utilisez la syntaxe suivante : « \.\COM10 ». Cette syntaxe fonctionne pour tous les numéros de port et matériels qui permettent aux numéros de port COM d’être spécifiés.

Pour plus d’informations sur les communications, consultez Communications.

consoles

La fonction CreateFile peut créer un handle pour l’entrée de console (CONIN$). Si le processus a un handle ouvert à celui-ci en raison de l’héritage ou de la duplication, il peut également créer un handle dans la mémoire tampon d’écran active (CONOUT$). Le processus appelant doit être attaché à une console héritée ou à une console allouée par la fonction AllocConsole . Pour les handles de console, définissez les paramètres CreateFile comme suit.

Paramètres	Valeur
lpFileName	Utilisez la valeur CONIN$ pour spécifier l’entrée de console. Utilisez la valeur CONOUT$ pour spécifier la sortie de la console. CONIN$ obtient un handle vers la mémoire tampon d’entrée de la console, même si la fonction SetStdHandle redirige le handle d’entrée standard. Pour obtenir le handle d’entrée standard, utilisez la fonction GetStdHandle. CONOUT$ obtient un handle vers la mémoire tampon d’écran active, même si SetStdHandle redirige le handle de sortie standard. Pour obtenir le handle de sortie standard, utilisez GetStdHandle.
dwDesiredAccess	`GENERIC_READ \| GENERIC_WRITE` est préférable, mais l’une ou l’autre peut limiter l’accès.
dwShareMode	Lors de l’ouverture de CONIN$, spécifiez FILE_SHARE_READ. Lors de l’ouverture de CONOUT$, spécifiez FILE_SHARE_WRITE. Si le processus appelant hérite de la console ou si un processus enfant doit être en mesure d’accéder à la console, ce paramètre doit être `FILE_SHARE_READ \| FILE_SHARE_WRITE`.
lpSecurityAttributes	Si vous souhaitez que la console soit héritée, le membre bInheritHandle de la structure SECURITY_ATTRIBUTES doit être TRUE.
dwCreationDisposition	Vous devez spécifier OPEN_EXISTING lors de l’utilisation de CreateFile pour ouvrir la console.
dwFlagsAndAttributes	Ignoré.
hTemplateFile	Ignoré.

Le tableau suivant présente différents paramètres de dwDesiredAccess et lpFileName.

lpFileName	dwDesiredAccess	Résultat
« CON »	GENERIC_READ	Ouvre la console pour l’entrée.
« CON »	GENERIC_WRITE	Ouvre la console pour la sortie.
« CON »	`GENERIC_READ \| GENERIC_WRITE`	Provoque l’échec de CreateFile ; GetLastError retourne ERROR_FILE_NOT_FOUND.

Mailslots

Si CreateFile ouvre la fin du client d’un maillot, la fonction retourne INVALID_HANDLE_VALUE si le client maillot tente d’ouvrir un maillot local avant que le serveur maillot ne l’ait créé avec la fonction CreateMailSlot.

Pour plus d’informations, consultez Mailslots.

canaux

Si CreateFile ouvre la fin du client d’un canal nommé, la fonction utilise n’importe quelle instance du canal nommé qui est dans l’état d’écoute. Le processus d’ouverture peut dupliquer le handle autant de fois que nécessaire, mais après son ouverture, l’instance de canal nommé ne peut pas être ouverte par un autre client. L’accès spécifié lorsqu’un canal est ouvert doit être compatible avec l’accès spécifié dans le paramètre dwOpenMode de la fonction CreateNamedPipe .

Si la fonction CreateNamedPipe n’a pas été correctement appelée sur le serveur avant cette opération, un canal n’existe pas et CreateFile échoue avec ERROR_FILE_NOT_FOUND.

S’il existe au moins une instance de canal actif, mais qu’il n’existe aucun canal d’écouteur disponible sur le serveur, ce qui signifie que toutes les instances de canal sont actuellement connectées, CreateFile échoue avec ERROR_PIPE_BUSY.

Pour plus d’informations, consultez Pipes.

Exemples

Les exemples d’opérations de fichier sont présentés dans les rubriques suivantes :

Les E/S d’appareil physique sont illustrées dans les rubriques suivantes :

appeler le DeviceIoControl
configuration d’un de ressources de communication
surveillance des événements de communication
traiter une demande de suppression d’un appareil

Un exemple utilisant des canaux nommés se trouve à client de canal nommé.

L’utilisation d’un maillot s’affiche dans Écriture dans un maillot.

Un extrait de code de sauvegarde sur bande se trouve à Création d’une application de sauvegarde.

Note

L’en-tête fileapi.h définit CreateFile comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	fileapi.h (include Windows.h)
bibliothèque	Kernel32.lib
DLL	Kernel32.dll