SCCRTN SccPopulateList (
LPVOID pvContext,
enum SCCCOMMAND nCommand,
LONG nFiles,
LPCSTR* lpFileNames,
POPLISTFUNC pfnPopulate,
LPVOID pvCallerData,
LPLONG lpStatus,
LONG fOptions
);
参数
pvContext
[in] 源代码管理插件上下文结构。nCommand
[in] 将应用于 lpFileNames 数组中的所有文件 (的源代码管理命令对于可能的命令列表参见 命令代码枚举器 )。nFiles
[in] 文件数。 lpFileNames 数组。lpFileNames
[in] 文件名为 IDE 的地址。pfnPopulate
[in] 调用的 IDE 回调函数添加和删除文件 (请参见 POPLISTFUNC 有关详细信息)。pvCallerData
[in] 值将按原样传递给回调函数。lpStatus
[in, out] 源代码管理插件的一个数组中返回每个文件的状态标志。fOptions
[in] 命令标志 (请参见 特定命令使用的位标志 “PopulateList 标志”部分有关详细信息)。
返回值
此函数的源代码管理插件实现应返回下列值之一:
值 |
说明 |
|---|---|
SCC_OK |
成功。 |
SCC_E_NONSPECIFICERROR |
未指定的错误。 |
备注
此功能检查文件列出其当前状态的。 文件时，在不匹配 nCommand时，标准它使用 pfnPopulate 回调函数通知调用方。 例如，在中，如果命令是 SCC_COMMAND_CHECKIN ，列表中的文件未签出，然后回调使用通知调用方。 有时，源代码管理插件看起来可能是命令的一部分并添加其其他文件。 这样，例如，检查其项，但的 .bmp 文件的 Visual Basic 用户不会出现在 Visual Basic 项目文件。 用户在 IDE 中选择 获取 命令。 IDE 将显示所有文件的列表可识别用户可以访问，因此，但，在列表中显示之前， SccPopulateList 函数调用来确定要显示的列表最新。
示例
IDE 会创建可识别的文件列表用户可以访问。 在它显示此列表之前，将调用 SccPopulateList 功能，它提供源代码管理插件机会从列表添加和删除文件。 该插件通过调用给定的回调函数修改列表有关更多详细信息 (请参见 POPLISTFUNC )。
该插件继续调用 pfnPopulate 功能，添加和删除文件，，直到完成从 SccPopulateList 函数然后返回。 IDE 会再显示其列表。 lpStatus 数组表示位于原始上的所有文件的列表通过 IDE。 除了使用回调函数外，该插件填充所有这些文件的状态。
备注
，按原样，源代码管理插件始终使用选项返回立即从该函数，保留列表。如果插件实现此功能，它可以指示此通过设置中的 SCC_CAP_POPULATELIST 功能 bitflag 第一次调用 SccInitialize 函数。默认情况下，该插件应始终假定，传递的所有项是文件。但是，因此，如果 IDE 设置在 fOptions 参数的 SCC_PL_DIR 标志，通过的所有项目均被视为内容。该插件应将目录所属的所有文件。IDE 在文件和目录混合不会传递。