通过

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缓冲区中。 否则，插件存储状态信息已更改的文件的完整路径名称，并返回相应的状态代码（文件状态代码中详述的值之一）。

另请参阅