源代码管理插件 API 函数
源代码管理插件 API 提供以下功能,这些函数必须由源代码管理插件根据此 API 实现。 本参考中详细介绍了每个函数的签名以及与位标志和其他参数关联的语义。
初始化和管家功能
函数 | 说明 |
---|---|
SccCloseProject | 关闭项目。 |
SccGetCommandOptions | 提示用户输入给定命令的高级选项。 |
SccGetVersion | 返回源代码管理插件的版本。 |
SccInitialize | 初始化源代码管理插件。 它针对插件的每个实例调用一次。 |
SccOpenProject | 打开项目。 |
SccSetOption | 用于设置各种选项的泛型函数。 每个选项都 SCC_OPT_xxx 以它自己的定义值集开头并具有其自己的值集。 |
SccUninitialize | 需要解开源代码管理插件时调用一次。 |
核心源代码管理函数
函数 | 说明 |
---|---|
SccAdd | 将完全限定的路径名称指定的文件数组添加到源代码管理系统。 |
SccAddFromScc | 允许用户浏览源代码管理系统中已有的文件,然后将这些文件设为当前项目的一部分。 |
SccCheckin | 签入文件数组。 |
SccCheckout | 签出文件数组。 |
SccDiff | 显示由完全限定的路径名称和源代码管理下的版本指定的本地用户文件之间的差异。 |
SccGet | 检索一组文件的只读副本。 |
SccGetEvents | 检查调用方询问的文件的状态(通过 SccQueryInfo )。 |
SccGetProjPath | 使源代码管理插件提示用户输入对插件有意义的项目路径。 |
SccHistory | 显示完全限定的本地文件名数组的历史记录。 |
SccPopulateList | 检查文件的当前状态列表。 此外,使用 pfnPopulate 函数在文件与条件 nCommand 不匹配时通知调用方。 |
SccProperties | 显示完全限定文件的属性。 |
SccQueryInfo | 检查其当前状态的完全限定文件列表。 |
SccRemove | 从源代码管理系统中删除完全限定的文件数组。 |
SccRename | 将给定文件重命名为源代码管理系统中的新名称。 |
SccRunScc | 访问源代码管理系统的全部功能。 |
SccUncheckout | 撤消文件数组的检查。 |
支持其他功能的函数(源代码管理插件 API 版本 1.2)
此函数组定义源代码管理插件 API 版本 1.2 中包含的附加功能。 它们提供对更高级的源代码管理特性和功能的访问权限。
函数 | 说明 |
---|---|
SccBeginBatch | 启动批处理操作。 |
SccCreateSubProject | 在现有父项目下创建具有给定名称的子项目。 |
SccDirDiff | 显示由完全限定的路径名称和源代码管理数据库位置指定的本地用户的目录之间的差异。 |
SccDirQueryInfo | 检查其当前状态的完全限定目录的列表。 |
SccEndBatch | 结束批处理操作。 |
SccGetParentProjectPath | 返回给定项目的父路径(项目必须存在)。 |
SccIsMultiCheckoutEnabled | 检查是否允许对文件进行多个检查输出。 |
SccWillCreateSccFile | 检查插件是否将创建 MSSCCPRJ。SCC 文件。 |
支持高级功能的函数(源代码管理插件 API 版本 1.3)
此函数组定义源代码管理插件 API 版本 1.3 中包含的附加功能。 它们提供对更高级的源代码管理特性和功能的访问权限。
函数 | 说明 |
---|---|
SccAddFilesFromSCC | 将源代码管理中的文件列表添加到当前项目。 |
SccBackgroundGet | 从源代码管理中检索文件列表,而无需用户界面。 |
SccEnumChangedFiles | 检索与本地文件不同的源代码管理中的文件列表。 |
SccGetExtendedCapabilities | 检索指定源代码管理插件支持的扩展功能的标志。 |
SccGetUserOption | 检索特定于用户的选项。 |
SccPopulateDirList | 检查在源代码管理下的项目或项目中的目录和文件列表。 找到的每个目录和文件名都传递给回调函数。 |
SccQueryChanges | 检查对文件列表所做的名称更改。 每个文件名都传递给具有其更改状态的回调函数。 |
要求
标头:scc.h
(默认情况下 ,环境 SDK 中提供的公共包含文件夹[驱动器]\Program Files\VSIP 8.0\EnvSDK\common\inc;还随 MSSCCI 示例 [drive]\Program Files\VSIP 8.0\MSSCCI 一起在 VSIP 文件夹中提供。