通过

winbase.h) (FILE_RENAME_INFO 结构

  • 项目

包含源文件应重命名的目标名称。 仅在调用 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