MoveFileA 函数 (winbase.h)

移动现有文件或目录,包括其子级。

若要指定如何移动文件,请使用 MoveFileExMoveFileWithProgress 函数。

若要将此操作作为事务处理操作执行,请使用 MoveFileTransacted 函数。

语法

BOOL MoveFileA(
  [in] LPCSTR lpExistingFileName,
  [in] LPCSTR lpNewFileName
);

参数

[in] lpExistingFileName

本地计算机上的文件或目录的当前名称。

默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 宽字符,请将“\\?\”前面追加到路径。 有关详细信息,请参阅 命名文件、路径和命名空间

提示

从 Windows 10 版本 1607 开始,你可以选择加入以删除MAX_PATH限制,而无需追加“\\?\”。 有关详细信息,请参阅 命名文件、路径和命名空间 的“最大路径长度限制”部分。

[in] lpNewFileName

文件或目录的新名称。 新名称不得已存在。 新文件可能位于其他文件系统或驱动器上。 新目录必须位于同一驱动器上。

默认情况下,名称限制为MAX_PATH个字符。 若要将此限制扩展到 32,767 宽字符,请将“\\?\”前面追加到路径。 有关详细信息,请参阅 命名文件、路径和命名空间

提示

从 Windows 10 版本 1607 开始,你可以选择加入以删除MAX_PATH限制,而无需追加“\\?\”。 有关详细信息,请参阅 命名文件、路径和命名空间 的“最大路径长度限制”部分。

返回值

如果函数成功,则返回值为非零。

如果函数失败,则返回值为零。 若要获取扩展的错误信息,请调用 GetLastError

言论

MoveFile 函数将在同一目录中或跨目录移动(重命名)文件或目录(包括其子目录)。 一个注意事项是,当目标位于其他卷上时,MoveFile 函数在目录移动时将失败。

如果文件跨卷移动,MoveFile 不会移动文件的安全描述符。 该文件将分配到目标目录中的默认安全描述符。

MoveFile 函数将其操作与链接跟踪服务协调,因此可以在移动链接源时进行跟踪。

在 Windows 8 和 Windows Server 2012 中,以下技术支持此函数。

科技 支持
服务器消息块 (SMB) 3.0 协议 是的
SMB 3.0 透明故障转移 (TFO) 请参阅批注
具有横向扩展文件共享的 SMB 3.0 (SO) 请参阅批注
群集共享卷文件系统 (CsvFS) 是的
可复原文件系统 (ReFS) 是的
 

SMB 3.0 不支持在具有持续可用性功能的文件共享上重命名备用数据流。

注意

winbase.h 标头将 MoveFile 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows XP [仅限桌面应用]
支持的最低服务器 Windows Server 2003 [仅限桌面应用]
目标平台 窗户
标头 winbase.h (包括 Windows.h)
Kernel32.lib
DLL Kernel32.dll

另请参阅

CopyFile

文件管理功能

MoveFileEx

MoveFileTransacted

MoveFileWithProgress