FILE_RENAME_INFO-Struktur (winbase.h)

  • Artikel

Enthält den Zielnamen, in den die Quelldatei umbenannt werden soll. Verwenden Sie nur beim Aufrufen von SetFileInformationByHandle.

Syntax

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;

Member

DUMMYUNIONNAME

DUMMYUNIONNAME.ReplaceIfExists

Dieses Feld wird verwendet, wenn der FileInformationClass-Parameter von SetFileInformationByHandle auf FileRenameInfo festgelegt ist. Wenn dieses Feld TRUE ist und die Zieldatei vorhanden ist, wird die Zieldatei durch die Quelldatei ersetzt. Wenn dieses Feld FALSE ist und die Zieldatei vorhanden ist, gibt der Vorgang einen Fehler zurück.

DUMMYUNIONNAME.Flags

Dieses Feld wird verwendet, wenn der FileInformationClass-Parameter von SetFileInformationByHandle auf FileRenameInfoEx festgelegt ist.

ReplaceIfExists

RootDirectory

Dieses Feld sollte auf NULL festgelegt werden.

FileNameLength

Die Größe von FileName in Bytes, ohne die NUL-Beendigung.

FileName[1]

Eine NUL-beendete Breitzeichenzeichenfolge, die den neuen Pfad zur Datei enthält. Der Wert kann in folgenden Formen vorliegen:

  • Ein absoluter Pfad (Laufwerk, Verzeichnis und Dateiname).
  • Ein Pfad relativ zum aktuellen Verzeichnis des Prozesses.
  • Der neue Name eines NTFS-Dateistreams, beginnend mit :.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2008 [nur Desktop-Apps]
Kopfzeile winbase.h (Windows.h einschließen)
Verteilbare Komponente Windows SDK unter Windows Server 2003 und Windows XP.

Weitere Informationen

FILE_INFO_BY_HANDLE_CLASS

SetFileInformationByHandle