通过

SccGetEvents 函数

该函数检索一个队列的状态事件。

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

参数

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

  • lpFileName
    [in, out] 缓冲区源代码管理插件使该返回的文件名 (到 _MAX_PATH 字符)。

  • lpStatus
    [in, out] 返回状态代码 (对于可能的值参见 文件状态代码枚举器 )。

  • pnEventsRemaining
    [in, out] 返回在队列项的数字在此之后调用。 如果此数字大，调用方可以决定立即调用 SccQueryInfo 函数 获取所有信息。

返回值

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

值

说明

SCC_OK

成功捕获事件。

SCC_E_OPNOTSUPPORTED

不支持此功能。

SCC_E_NONSPECIFICERROR

未指定的错误。

备注

此功能称为在空闲处理看到过程中是否有文件的任何状态更新受源代码管理。 源代码管理插件维护它知道所有文件的状态和，只要状态的更改该插件请注意，该状态，并关联的文件在队列中。 当 SccGetEvents 调用时，队列的顶部元素检索并返回。 此功能约束返回以前仅缓存的信息，且必须具有非常快周转 (即没有读取磁盘或请求源代码管理系统状态);否则 IDE 的性能会启动降低。

如果不报告的状态更新，源代码管理插件缓冲区存储一个空字符串指向由 lpFileName。 否则，该插件存储状态信息已更改文件的完整路径名并返回适当的状态代码 (在 文件状态代码枚举器详细的某个值)。

请参见

参考

文件状态代码枚举器

概念

源代码管理插件 API 函数