Функции API подключаемого модуля системы управления версиями
Подключаемый модуль управления версиями предоставляет следующие функции, которые должны быть реализованы подключаемым модулем управления версиями в соответствии с этим API. Подписи каждой функции и семантики, связанные с битовыми флагами и другими параметрами, подробно описаны в этой ссылке.
Функции инициализации и обслуживания дома
| Function | Description |
|---|---|
| SccCloseProject | Закрывает проект. |
| SccGetCommandOptions | Запрашивает у пользователя дополнительные параметры для данной команды. |
| SccGetVersion | Возвращает версию подключаемого модуля управления версиями. |
| SccInitialize | Инициализирует подключаемый модуль управления версиями. Он вызывается один раз для каждого экземпляра подключаемого модуля. |
| SccOpenProject | Открывает проект. |
| SccSetOption | Универсальная функция, используемая для задания различных параметров. Каждый параметр начинается с SCC_OPT_xxx и имеет собственный набор значений. |
| SccUninitialize | Вызывается один раз, когда подключаемый модуль управления версиями должен быть отключен. |
Основные функции управления версиями
| Function | Description |
|---|---|
| SccAdd | Добавляет массив файлов, указанных полными именами путей в систему управления версиями. |
| SccAddFilesFromSCC | Позволяет пользователю просматривать файлы, которые уже находятся в системе управления версиями, а затем сделать эти файлы частью текущего проекта. |
| SccCheckin | Проверяет массив файлов. |
| SccCheckout | Извлекает массив файлов. |
| SccDiff | Показывает различия между файлом локального пользователя, указанным полным именем пути и версией в системе управления версиями. |
| SccGet | Извлекает копию только для чтения набора файлов. |
| SccGetEvents | Проверяет состояние файлов, о которые вызывающий запрос спросил (через SccQueryInfo). |
| SccGetProjPath | Вызывает подключаемый модуль управления версиями для запроса пользователя на путь к проекту, который имеет смысл для подключаемого модуля. |
| SccHistory | Отображает журнал для массива полных имен локальных файлов. |
| SccPopulateList | Проверяет список файлов для их текущего состояния. Кроме того, функция использует pfnPopulate функцию, чтобы уведомить вызывающего пользователя, если файл не соответствует критериям.nCommand |
| SccProperties | Отображает свойства полного файла. |
| SccQueryInfo | Проверяет список полных файлов для их текущего состояния. |
| SccRemove | Удаляет массив полных файлов из системы управления версиями. |
| SccRename | Переименовывает указанный файл в новое имя в системе управления версиями. |
| SccRunScc | Обращается к полному спектру функций системы управления версиями. |
| SccUncheckout | Отменяет проверка из массива файлов. |
Функции, поддерживающие дополнительные возможности (версия 1.2 API подключаемого модуля управления версиями)
Эта группа функций определяет дополнительные функциональные возможности, включенные в API подключаемого модуля управления версиями 1.2. Они предоставляют доступ к более сложным функциям и возможностям системы управления версиями.
| Function | Description |
|---|---|
| SccBeginBatch | Запускает пакетную операцию. |
| SccCreateSubProject | Создает подпроект с заданным именем в существующем родительском проекте. |
| SccDirDiff | Показывает различия между каталогом локального пользователя, заданным полным именем пути и расположением базы данных управления версиями. |
| SccDirQueryInfo | Проверяет список полных каталогов для их текущего состояния. |
| SccEndBatch | Завершает пакетную операцию. |
| SccGetParentProjectPath | Возвращает родительский путь данного проекта (проект должен существовать). |
| SccIsMultiCheckoutEnabled | Проверяет, разрешено ли несколько проверка outs в файле. |
| SccWillCreateSccFile | Проверяет, будет ли подключаемый модуль создавать MSSCCPRJ. Файлы SCC. |
Функции, поддерживающие расширенные возможности (версия 1.3 api подключаемого модуля управления версиями)
Эта группа функций определяет дополнительные функциональные возможности, включенные в API подключаемого модуля управления версиями 1.3. Они предоставляют доступ к более сложным функциям и возможностям системы управления версиями.
| Function | Description |
|---|---|
| SccAddFilesFromSCC | Добавляет список файлов из системы управления версиями в текущий проект. |
| SccBackgroundGet | Извлекает список файлов из системы управления версиями без пользовательского интерфейса. |
| SccEnumChangedFiles | Извлекает список файлов в системе управления версиями, отличных от локальных файлов. |
| SccGetExtendedCapabilities | Извлекает флаги, которые указывают расширенные возможности, поддерживаемые подключаемым модулем управления версиями. |
| SccGetUserOption | Извлекает параметры, относящиеся к пользователю. |
| SccPopulateDirList | Проверяет список каталогов и файлов в проекте или проектах, которые находятся под управлением версиями. Каждый каталог и имя файла передаются в функцию обратного вызова. |
| SccQueryChanges | Проверяет изменения имени, внесенные в список файлов. Каждое имя файла передается функции обратного вызова с его состоянием изменения. |
Requirements
Заголовок: scc.h
(По умолчанию в пакете SDK для среды используется папка.[диск]\Program Files\VSIP 8.0\EnvSDK\common\inc; также в папке VSIP с примером MSSCCI [диск]\Program Files\VSIP 8.0\MSSCCI).