POPLISTFUNC

此回调由 IDE 提供给 SccPopulateList ,由源代码管理插件用来更新文件或目录列表(也提供给 SccPopulateList 函数)。

当用户 在 IDE 中选择 Get 命令时,IDE 将显示用户可以获取的所有文件的列表框。 遗憾的是,IDE 不知道用户可能获取的所有文件的确切列表;只有插件具有此列表。 如果其他用户已将文件添加到源代码控制项目,这些文件应显示在列表中,但 IDE 不知道这些文件。 IDE 会生成一个文件列表,该列表认为用户可以获取这些文件。 在向用户显示此列表之前,它会调用 SccPopulateList, ,使源代码管理插件有机会从列表中添加和删除文件。

Signature

源代码管理插件通过使用以下原型调用 IDE 实现的函数来修改列表:

typedef BOOL (*POPLISTFUNC) (
   LPVOID pvCallerData,
   BOOL fAddRemove,
   LONG nStatus,
   LPSTR lpFileName
);

参数

pvCallerData 调用 pvCallerData 方(IDE) 传递给 SccPopulateList 的参数。 源代码管理插件不应假定此参数的内容。

fAddRemove If TRUElpFileName 是应添加到文件列表的文件。 lpFileName如果是FALSE应从文件列表中删除的文件。

nStatus 状态 lpFileName (位的组合 SCC_STATUS );有关详细信息,请参阅 文件状态代码

要从列表中添加或删除的文件名的 lpFileName 完整目录路径。

返回值

说明
TRUE 插件可以继续调用此函数。
FALSE IDE 端出现了问题(例如内存不足的情况)。 插件应停止操作。

备注

对于源代码管理插件要从文件列表中添加或删除的每个文件,它会调用此函数,传入此 lpFileName函数。 该 fAddRemove 标志指示要添加到列表的新文件或要删除的旧文件。 该 nStatus 参数提供文件的状态。 当 SCC 插件完成添加和删除文件时,它将从 SccPopulateList 调用返回。

注意

SCC_CAP_POPULATELIST Visual Studio 需要功能位。

另请参阅