Поделиться через

Функция SccGetEvents

  • Статья

Эта функция извлекает событие состояния в очереди.

Синтаксис

SCCRTN SccGetEvents (
   LPVOID pvContext,
   LPSTR  lpFileName,
   LPLONG lpStatus,
   LPLONG pnEventsRemaining
);

Параметры

pvContext

[in] Структура контекста подключаемого модуля управления версиями.

lpFileName

[in, out] Буфер, в котором подключаемый модуль управления версиями помещает возвращаемое имя файла (до _MAX_PATH символов).

lpStatus

[in, out] Возвращает код состояния (см . код состояния файла для возможных значений).

pnEventsRemaining

[in, out] Возвращает количество записей, оставшихся в очереди после этого вызова. Если это число большое, вызывающий объект может решить вызвать SccQueryInfo , чтобы получить всю информацию одновременно.

Возвращаемое значение

Реализация подключаемого модуля управления версиями этой функции должна возвращать одно из следующих значений:

значение Описание
SCC_OK Получение событий выполнено успешно.
SCC_E_OPNOTSUPPORTED Эта функция не поддерживается.
SCC_E_NONSPECIFICERROR Неспецифический сбой.

Замечания

Эта функция вызывается во время простоя обработки, чтобы узнать, были ли обновления состояния для файлов в системе управления версиями. Подключаемый модуль управления версиями сохраняет состояние всех файлов, о которых он знает, и всякий раз, когда изменение состояния отмечается подключаемым модулем, состояние и связанный файл хранятся в очереди. При SccGetEvents вызове верхний элемент очереди извлекается и возвращается. Эта функция ограничена возвратом только ранее кэшированных сведений и должна иметь очень быстрое обходное решение (т. е. не считывание диска или запрос системы управления версиями для состояния); В противном случае производительность интегрированной среды разработки может снизиться.

Если для отчета нет обновления состояния, подключаемый модуль управления версиями сохраняет пустую строку в буфере, на которую указывает lpFileName. В противном случае подключаемый модуль сохраняет полное имя файла, для которого изменены сведения о состоянии и возвращает соответствующий код состояния (одно из значений, подробное в коде состояния файла).

См. также