PGET_EVENT_MESSAGE回调函数 (routprot.h)

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 以外的方式）更改了与其某个接口关联的配置信息。路由协议请求路由器管理器检索并永久存储此信息。消息包含接口的 ID。
UPDATE_COMPLETE	路由协议已完成路由器管理器的自动静态更新请求。路由器管理器将收到的路由信息转换为静态。该消息包含执行更新的接口的索引、 (路由或服务) 接收的信息类型，以及指示更新是否成功的结果字段。请参阅 DoUpdateRoutes 和 DoUpdateServices。

[out] Result

指向 MESSAGE 联合的指针。消息的内容特定于报告的事件。

此参数是可选的;调用方可以为此参数指定 NULL 。

如果成功检索条目，则返回值NO_ERROR。

如果路由协议的消息队列不包含任何条目，则返回值ERROR_NO_MORE_ITEMS。