Функция SccGetCommandOptions
Эта функция запрашивает у пользователя для дополнительных параметров для данной команды.
SCCRTN SccGetCommandOptions(
LPVOID pvContext,
HWND hWnd,
enum SCCCOMMAND iCommand,
LPCMDOPTS* ppvOptions
);
Параметры
pvContext
[in] структура контекста системы управления версиями подключаемых модулей.hWnd
[in] маркер а в окно интегрированной среды разработки, подключаемый модуль системы управления версиями может использоваться как родительский для всех диалоговых окон, которые он содержит.iCommand
[in] команда, для которой запрашиваются (см. дополнительные параметры. Перечислитель кода команд возможные значения).ppvOptions
[in] структура параметра (может быть также NULL).
Возвращаемое значение
Предполагается, что возвращает реализация подключаемых модулей системы управления версиями этой функции одно из следующих значений:
Значение |
Описание |
|---|---|
SCC_OK |
Успех. |
SCC_I_ADV_SUPPORT |
Подключаемый модуль системы управления версиями поддерживает дополнительные параметры для команды. |
SCC_I_OPERATIONCANCELED |
Пользователь отменил plug-in системы управления версиями Параметры диалоговое окно. |
SCC_E_OPTNOTSUPPORTED |
Подключаемый модуль системы управления версиями не поддерживает эту операцию. |
SCC_E_ISCHECKEDOUT |
Невозможно выполнить данную операцию для файла, который в настоящий момент извлечен. |
SCC_E_ACCESSFAILURE |
Возникла проблема при доступе к система управления версиями, возможно, из-за проблем с сетью или конкуренции. Повтор рекомендуется. |
SCC_E_NONSPECIFICERROR |
Неспецифичный сбой. |
Заметки
Интегрированная среда разработки вызывает данную функцию, впервые с ppvOptions=NULL определить, является ли подключаемый модуль системы управления версиями поддерживают функцию дополнительных параметров для заданной команды. Если подключаемый модуль поддерживает функцию для этой команды, интегрированная среда разработки вызывает данную функцию еще раз, когда дополнительные параметры запросов пользователя (обычно снабжаемые как Дополнительно в диалоговом окне) и указатель, отличных от null, для поставках ppvOptions эти точки к a NULL указатель. Подключаемый модуль содержит все дополнительные параметры, указанные пользователем в закрытой структурой и возвращает указатель на этой структуре in ppvOptions. Эта структура затем передается для всех других функций API системы управления версиями вставляемым, которые необходимо знать о ней, включая последующие вызовы SccGetCommandOptions функция.
Пример может помочь прояснить эту ситуацию.
Пользователь выбирает Получить команда и интегрированная среда разработки отображается a Получить диалоговое окно. Интегрированная среда разработки вызывает SccGetCommandOptions функция заменена iCommand значение SCC_COMMAND_GET и ppvOptions значение NULL. Это интерпретируется подключаемым модулем системы управления версиями, как вопрос "имеется все дополнительные параметры для данной команды?" Если подключаемый модуль возвращает SCC_I_ADV_SUPPORTинтегрированная среда разработки отображает Дополнительно кнопка в своем Получить диалоговое окно.
В первый раз, когда пользователь щелкает Дополнительно кнопки интегрированная среда разработки снова вызывает SccGetCommandOptions функция это время с подписчиков, не являющихсяNULLppvOptions эти точки к a NULL указатель. Подключаемый модуль выводит его Получает параметры диалоговое окно ", приглашения пользователю сведения, помещает эти сведения в собственную структуру и возвращает указатель на этой структуре in ppvOptions.
Если пользователь щелкнет Дополнительно опять-таки в одном диалоговом окне, интегрированная среда разработки вызывает SccGetCommandOptions функцию снова без изменения ppvOptionsтак, что структура будет передается обратно на подключаемому модулю. Это позволяет подключаемый модуль, чтобы повторно инициализировать ее диалоговое окно к значениям, по которому пользователь был ранее установлен. Подключаемый модуль изменяет структуру на месте до возвращения.
Наконец, когда пользователь щелкает ОК в интегрированной среды разработки Получить диалоговое окно " интегрированная среда разработки вызывает Функция SccGet, которому передаются в структуру, возвращаемую ppvOptions содержит дополнительные параметры.
Примечание
Команда SCC_COMMAND_OPTIONS используется, когда интегрированная среда разработки отображает Параметры откроется диалоговое окно, в котором предпочтениям набора пользователя, отслеживающие как интеграция работает.Если подключаемый модуль системы управления версиями необходимо предоставить собственное диалоговое окна параметры, он может отобразить его из Дополнительно в диалоговом окне параметры интегрированной среды разработки.Подключаемый модуль только отвечает за получение и сохранения этих данных; интегрированная среда разработки не использует ее или не изменяет его.
См. также
Ссылки
Основные понятия
Функции API подключаемых модулей системы управления версиями