POPLISTFUNC
Этот обратный вызов предоставляется интегрированной среде разработки SccPopulateList и используется подключаемым модулем системы управления версиями для обновления списка файлов или каталогов (также предоставленных SccPopulateList
функции).
Когда пользователь выбирает команду Get в интегрированной среде разработки, интегрированная среда разработки отображает список всех файлов, которые пользователь может получить. К сожалению, интегрированная среда разработки не знает точный список всех файлов, которые может получить пользователь; Только подключаемый модуль содержит этот список. Если другие пользователи добавили файлы в проект управления исходным кодом, эти файлы должны отображаться в списке, но интегрированная среда разработки не знает о них. Интегрированная среда разработки создает список файлов, которые он считает, что пользователь может получить. Перед отображением этого списка пользователю он вызывает SccPopulateList,
, предоставляя подключаемый модуль управления версиями возможность добавлять и удалять файлы из списка.
Подпись
Подключаемый модуль управления версиями изменяет список путем вызова функции, реализованной в интегрированной среде разработки, со следующим прототипом:
typedef BOOL (*POPLISTFUNC) (
LPVOID pvCallerData,
BOOL fAddRemove,
LONG nStatus,
LPSTR lpFileName
);
Параметры
pvCallerData— pvCallerData
параметр, переданный вызывающим элементом (IDE) в SccPopulateList. Подключаемый модуль управления версиями не должен предполагать ничего о содержимом этого параметра.
fAddRemove If TRUE
— lpFileName
это файл, который следует добавить в список файлов. Если FALSE
это lpFileName
файл, который следует удалить из списка файлов.
nStatus Status of lpFileName
(сочетание SCC_STATUS
битов; дополнительные сведения см. в разделе "Код состояния файла").
Полный путь к каталогу lpFileName имени файла для добавления или удаления из списка.
Возвращаемое значение
значение | Описание |
---|---|
TRUE |
Подключаемый модуль может продолжать вызывать эту функцию. |
FALSE |
Возникла проблема на стороне интегрированной среды разработки (например, из-за нехватки памяти). Подключаемый модуль должен остановить операцию. |
Замечания
Для каждого файла, который подключаемый модуль управления версиями хочет добавить или удалить из списка файлов, вызывает эту функцию, передавая его lpFileName
. Флаг fAddRemove
указывает новый файл, добавляемый в список или старый файл для удаления. Параметр nStatus
предоставляет состояние файла. Когда подключаемый модуль SCC завершил добавление и удаление файлов, он возвращается из вызова SccPopulateList .
Примечание.
Для SCC_CAP_POPULATELIST
Visual Studio требуется бит возможностей.