structure FILE_RENAME_INFO (winbase.h)

Contient le nom cible auquel le fichier source doit être renommé. Utilisez uniquement lors de l’appel de SetFileInformationByHandle.

Syntaxe

typedef struct _FILE_RENAME_INFO {
  union {
    BOOLEAN ReplaceIfExists;
    DWORD   Flags;
  } DUMMYUNIONNAME;
  BOOLEAN ReplaceIfExists;
  HANDLE  RootDirectory;
  DWORD   FileNameLength;
  WCHAR   FileName[1];
} FILE_RENAME_INFO, *PFILE_RENAME_INFO;

Members

DUMMYUNIONNAME

DUMMYUNIONNAME.ReplaceIfExists

Ce champ est utilisé lorsque le paramètre FileInformationClass de SetFileInformationByHandle est défini sur FileRenameInfo. Si ce champ a la valeur TRUE et que le fichier cible existe, le fichier cible est remplacé par le fichier source. Si ce champ a la valeur FALSE et que le fichier cible existe, l’opération retourne une erreur.

DUMMYUNIONNAME.Flags

Ce champ est utilisé lorsque le paramètre FileInformationClass de SetFileInformationByHandle est défini sur FileRenameInfoEx.

ReplaceIfExists

RootDirectory

Définissez la valeur NULL dans le cas courant. Si FileName spécifie un nom relatif, ce champ peut être un handle vers le répertoire par rapport auquel le nouveau nom est résolu.

FileNameLength

Taille de FileName en octets. Un caractère null de fin n’est pas obligatoire.

FileName[1]

Chaîne de caractères larges terminée par un nul contenant le nouveau chemin d’accès au fichier. Il peut s’agir de l’une des valeurs suivantes :

  • Chemin absolu (lecteur, répertoire et nom de fichier).
  • Chemin d’accès relatif au répertoire actif du processus.
  • Nouveau nom d’un flux de fichiers NTFS, en commençant par :.

Exigences

Requirement Valeur
Client minimum requis Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau uniquement]
En-tête winbase.h (inclure Windows.h)
Composant redistribuable Windows SDK sur Windows Server 2003 et Windows XP.

Voir aussi

FILE_INFO_BY_HANDLE_CLASS

SetFileInformationByHandle