функция обратного вызова PGET_EVENT_MESSAGE (routprot.h)

Статья
03/01/2024

Функция GetEventMessage получает запись из очереди сообщений протокола маршрутизации. Протокол маршрутизации использует очередь для информирования диспетчера маршрутизатора об асинхронных событиях.

Синтаксис

PGET_EVENT_MESSAGE PgetEventMessage;

DWORD PgetEventMessage(
  [out] ROUTING_PROTOCOL_EVENTS *Event,
  [out] MESSAGE *Result
)
{...}

Параметры

[out] Event

Указатель на событие. Сведения об этом событии передаются в связанном сообщении. Обратите внимание, что это не объект события. (Тип ROUTING_PROTOCOL_EVENTS объявлен в Routprot.h.)

Этот параметр получает одно из следующих значений:

Значение	Значение
ROUTER_STOPPED	Протокол маршрутизатора успешно завершает работу. Сообщение пусто для этого события. (См. Раздел StopProtocol)
SAVE_GLOBAL_CONFIG_INFO	Протокол маршрутизации сообщает, что сведения о глобальной конфигурации были изменены внешним агентом, т. е. с помощью средств, отличных от SetGlobalInfo. Протокол маршрутизации запрашивает получение и постоянное хранение этих сведений диспетчером маршрутизатора. Сообщение пусто для этого события.
SAVE_INTERFACE_CONFIG_INFO	Протокол маршрутизации сообщает, что сведения о конфигурации, связанные с одним из его интерфейсов, были изменены внешним агентом, т. е. с помощью средств, отличных от SetInterfaceInfo. Протокол маршрутизации запрашивает получение и постоянное хранение этих сведений диспетчером маршрутизатора. Сообщение содержит идентификатор интерфейса.
UPDATE_COMPLETE	Протокол маршрутизации завершил автоматический запрос на обновление от диспетчера маршрутизатора. Диспетчер маршрутизатора преобразует полученные сведения о маршрутизации в статические. Сообщение содержит индекс интерфейса, в котором было выполнено обновление, тип полученной информации (маршруты или службы) и поле результата, указывающее, успешно ли выполнено обновление. См . раздел DoUpdateRoutes и DoUpdateServices.

[out] Result

Указатель на объединение MESSAGE . Содержимое сообщения зависит от сообщаемого события.

Этот параметр является необязательным; вызывающий объект может указать значение NULL для этого параметра.

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

Если запись успешно получена, возвращаемое значение будет NO_ERROR.

Если очередь сообщений протокола маршрутизации не содержит записей, возвращаемое значение будет ERROR_NO_MORE_ITEMS.

Требования

Требование	Значение
Минимальная версия клиента	Ни одна версия не поддерживается
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	routprot.h