struktur FILE_RENAME_INFO (winbase.h)

Berisi nama target tempat file sumber harus diganti namanya. Gunakan hanya saat memanggil SetFileInformationByHandle.

Sintaks

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;

Anggota

DUMMYUNIONNAME

DUMMYUNIONNAME.ReplaceIfExists

Bidang ini digunakan ketika parameter FileInformationClassSetFileInformationByHandle diatur ke FileRenameInfo. Jika bidang ini TRUE dan file target ada maka file target akan digantikan oleh file sumber. Jika bidang ini FALSE dan file target ada, maka operasi akan mengembalikan kesalahan.

DUMMYUNIONNAME.Flags

Bidang ini digunakan ketika parameter FileInformationClassSetFileInformationByHandle diatur ke FileRenameInfoEx.

ReplaceIfExists

RootDirectory

Bidang ini harus diatur ke NULL.

FileNameLength

Ukuran FileName dalam byte, tidak termasuk penghentian NUL.

FileName[1]

String karakter lebar yang dihentikan NUL yang berisi jalur baru ke file. Nilainya bisa menjadi salah satu dari berikut ini:

• Jalur absolut (drive, direktori, dan nama file).
• Jalur yang relatif terhadap direktori proses saat ini.
• Nama baru aliran file NTFS, dimulai dengan :.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Header	winbase.h (termasuk Windows.h)
Redistribusi	Windows SDK di Windows Server 2003 dan Windows XP.

Lihat juga

FILE_INFO_BY_HANDLE_CLASS

SetFileInformationByHandle