FILE_RENAME_INFO winbase.h) (結構)

  • 發行項

包含來源檔案應該重新命名的目標名稱。 只有在呼叫 SetFileInformationByHandle 時才使用。

語法

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;

成員

DUMMYUNIONNAME

DUMMYUNIONNAME.ReplaceIfExists

當 SetFileInformationByHandle 的 FileInformationClass 參數設定為 FileRenameInfo 時，會使用此欄位。 如果此欄位為 TRUE ，且目標檔案存在，則目標檔案將會由來源檔案取代。 如果此欄位為 FALSE ，且目標檔案存在，則作業會傳回錯誤。

DUMMYUNIONNAME.Flags

當 SetFileInformationByHandle 的 FileInformationClass 參數設定為 FileRenameInfoEx 時，會使用此欄位。

ReplaceIfExists

RootDirectory

此欄位應設定為 NULL。

FileNameLength

FileName 的大小，以位元組為單位，不包括 NUL 終止。

FileName[1]

包含檔案新路徑的 NUL 終止寬字元字串。 這個值可以是下列值之一：

  • (磁碟驅動器、目錄和檔名) 的絕對路徑。
  • 相對於進程目前目錄的路徑。
  • NTFS 檔案資料流的新名稱，開頭為 :。

規格需求

需求 值
最低支援的用戶端 Windows Vista [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2008 [僅限傳統型應用程式]
標頭 winbase.h (包含 Windows.h)
可轉散發套件 Windows Server 2003 和 Windows XP 上的 Windows SDK。

另請參閱

FILE_INFO_BY_HANDLE_CLASS

SetFileInformationByHandle