通过

SccQueryInfo 函数

  • 项目

此函数获取源代码管理下一组选定文件的状态信息。

语法

SCCRTN SccQueryInfo(
   LPVOID  pvContext,
   LONG    nFiles,
   LPCSTR* lpFileNames,
   LPLONG  lpStatus
);

参数

pvContext

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

nFiles

[in]数组中指定的 lpFileNames 文件数和数组的 lpStatus 长度。

lpFileNames

[in]要查询的文件的名称数组。

lpStatus

[in， out]源代码管理插件返回每个文件的状态标志的数组。 有关详细信息，请参阅 文件状态代码。

返回值

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

值 说明
SCC_OK 查询成功。
SCC_E_ACCESSFAILURE 访问源代码管理系统时出现问题，可能是由网络或争用问题引起的。 建议重试。
SCC_E_PROJNOTOPEN 该项目未在源代码管理下打开。
SCC_E_NONSPECIFICERROR 非特定故障。

注解

如果 lpFileName 为空字符串，则当前没有要更新的状态信息。 否则，它是状态信息可能已更改的文件的完整路径名称。

返回数组可以是位掩码 SCC_STATUS_xxxx 。 有关详细信息，请参阅 文件状态代码。 源代码管理系统可能不支持所有位类型。 例如，如果未 SCC_STATUS_OUTOFDATE 提供，则位只是未设置。

使用此函数检查文件时，请注意以下MSSCCI状态要求：

  • SCC_STATUS_OUTBYUSER设置当前用户已检查文件。

  • SCC_STATUS_CHECKEDOUT 除非 SCC_STATUS_OUTBYUSER 已设置，否则无法设置。

  • SCC_STATUS_CHECKEDOUT仅在文件被检查到指定的工作目录中时才设置。

  • 如果当前用户将文件检查到工作目录以外的目录中，SCC_STATUS_OUTBYUSER则设置但SCC_STATUS_CHECKEDOUT未设置。

另请参阅