SccRename 函数

此函数重命名源代码管理系统中的文件。

语法

SCCRTN SccRename(
   LPVOID pvContext,
   HWND   hWnd,
   LPCSTR lpFileName,
   LPCSTR lpNewName
);

参数

pvContext

[in]源代码管理插件上下文结构。

hWnd

[in]源代码管理插件可以作为其提供的任何对话框的父级的 IDE 窗口的句柄。

lpFileName

[in]要重命名的文件的完全限定文件名。

lpNewName

[in]完全限定的新名称。 如果目录路径不同，则文件已从一个子目录移动到另一个子目录。

返回值

此函数的源代码管理插件实现应返回以下值之一：

值	说明
SCC_OK	重命名操作已成功完成。
SCC_E_PROJNOTOPEN	该项目未在源代码管理下打开。
SCC_E_FILENOTCONTROLLED	该文件不在源代码管理下。
SCC_E_ACCESSFAILURE	访问源代码管理系统时出现问题，可能是因为网络或争用问题。
SCC_E_NOTAUTHORIZED	用户无权完成此操作。
SCC_E_COULDNOTCREATEPROJECT	无法创建项目作为重命名过程的一部分。
SCC_E_OPNOTPERFORMED	未执行该操作。
SCC_E_NONSPECIFICERROR	发生未指定或常规错误。

备注

此函数可用于重命名文件或将其从源代码管理系统中的一个位置移到另一个位置。 源代码管理插件不应尝试访问磁盘上的文件。 IDE 负责重命名本地文件。

另请参阅

• 源代码管理插件 API 函数