Функция SccAdd
Эта функция добавляет новые файлы в систему управления версиями.
Синтаксис
SCCRTN SccAdd(
LPVOID pvContext,
HWND hWnd,
LONG nFiles,
LPCSTR* lpFileNames,
LPCSTR lpComment,
LONG* pfOptions,
LPCMDOPTS pvOptions
);
Параметры
pvContext
[in] Структура контекста подключаемого модуля управления версиями.
hWnd
[in] Дескриптор окна интегрированной среды разработки, который подключаемый модуль управления версиями может использовать в качестве родительского элемента для любых диалоговых окон, которые он предоставляет.
nFiles
[in] Количество файлов, выбранных для добавления в текущий проект, как указано в массиве lpFileNames
.
lpFileNames
[in] Массив полных локальных имен файлов, добавляемых.
lpComment
[in] Комментарий, применяемый ко всем добавленным файлам.
pfOptions
[in] Массив флагов команд, предоставляемых на основе каждого файла.
pvOptions
[in] Параметры подключаемого модуля управления версиями.
Возвращаемое значение
Реализация подключаемого модуля управления версиями этой функции должна возвращать одно из следующих значений:
значение | Описание |
---|---|
SCC_OK | Операция добавления была успешной. |
SCC_E_FILEALREADYEXISTS | Выбранный файл уже находится под управлением версиями. |
SCC_E_TYPENOTSUPPORTED | Тип файла (например, двоичного файла) не поддерживается системой управления версиями. |
SCC_E_OPNOTSUPPORTED | Система управления версиями не поддерживает эту операцию. |
SCC_E_ACCESSFAILURE | Возникла проблема с доступом к системе управления версиями, вероятно, из-за проблем с сетью или спором. Рекомендуется повторить попытку. |
SCC_E_NOTAUTHORIZED | Пользователю не разрешено выполнять эту операцию. |
SCC_E_NONSPECIFICERROR | Неспецифический сбой; добавление не выполнено. |
SCC_I_OPERATIONCANCELED | Операция была отменена до завершения. |
SCC_I_RELOADFILE | Файл или проект необходимо перезагрузить. |
SCC_E_FILENOTEXIST | Локальный файл не найден. |
Замечания
Обычные fOptions
заменяются здесь массивом с pfOptions
одной LONG
спецификацией параметра для каждого файла. Это связано с тем, что тип файла может отличаться от файла к файлу.
Примечание.
Недопустимо указать оба SCC_FILETYPE_TEXT
файла и SCC_FILETYPE_BINARY
параметры для одного и того же файла, но это допустимо, чтобы указать ни одно. Параметр не совпадает с параметром SCC_FILETYPE_AUTO
, в этом случае подключаемый модуль управления версиями автоматически определяет тип файла.
Ниже приведен список флагов, используемых в массиве pfOptions
:
Вариант | Значение | Значение |
---|---|---|
SCC_FILETYPE_AUTO | 0x00 | Подключаемый модуль управления версиями должен обнаруживать тип файла. |
SCC_FILETYPE_TEXT | 0x01 | Указывает текстовый файл ASCII. |
SCC_FILETYPE_BINARY | 0x02 | Указывает тип файла, отличный от текста ASCII. |
SCC_ADD_STORELATEST | 0x04 | Сохраняет только последнюю копию файла без разностных изменений. |
SCC_FILETYPE_TEXT_ANSI | 0x08 | Обрабатывает файл как текст ANSI. |
SCC_FILETYPE_UTF8 | 0x10 | Обрабатывает файл как текст Юникода в формате UTF8. |
SCC_FILETYPE_UTF16LE | 0x20 | Обрабатывает файл как текст Юникода в формате UTF16 Little Endian. |
SCC_FILETYPE_UTF16BE | 0x40 | Обрабатывает файл как текст Юникода в формате Big Endian UTF16. |