PGET_EVENT_MESSAGE回呼函式 (routprot.h)

GetEventMessage 函式會從路由通訊協定的訊息佇列取得專案。 路由通訊協定會使用佇列來通知路由器管理員異步事件。

語法

PGET_EVENT_MESSAGE PgetEventMessage;

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

參數

[out] Event

事件的指標。 相關訊息中會報告此事件的相關信息。 請注意,這不是事件物件。 (Routprot.h.) 中宣告 ROUTING_PROTOCOL_EVENTS 類型

此參數會收到下列其中一個值:

意義
ROUTER_STOPPED
路由器通訊協定已成功關閉。 此事件的訊息是空的。 (請參閱 StopProtocol)
SAVE_GLOBAL_CONFIG_INFO
路由通訊協議會報告其全域設定資訊已由外部代理程序變更,也就是透過 SetGlobalInfo 以外的方法。 路由通訊協定會要求路由器管理員擷取並永久儲存此資訊。 此事件的訊息是空的。
SAVE_INTERFACE_CONFIG_INFO
路由通訊協議會報告與其中一個介面相關聯的組態資訊已由外部代理程序變更,也就是透過 SetInterfaceInfo 以外的方式變更。 路由通訊協定會要求路由器管理員擷取並永久儲存此資訊。 訊息包含介面的標識碼。
UPDATE_COMPLETE
路由協定已完成路由器管理員的自動更新要求。 路由器管理員會將收到的路由信息轉換為靜態。 訊息包含執行更新的介面索引、 (路由或服務) 接收的信息類型,以及指出更新是否成功的結果欄位。 請參閱 DoUpdateRoutesDoUpdateServices

[out] Result

MESSAGE 等位的指標。 訊息的內容是報告事件特有的。

此參數是選擇性的;呼叫端可以指定此參數的 NULL

傳回值

如果成功擷取項目,傳回值會NO_ERROR。

如果路由通訊協定的訊息佇列不包含任何專案,則會ERROR_NO_MORE_ITEMS傳回值。

規格需求

需求
最低支援的用戶端 都不支援
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
目標平台 Windows
標頭 routprot.h

另請參閱

DoUpdateRoutes

DoUpdateServices

消息

路由通訊協定介面函式

路由通訊協定介面參考

SetGlobalInfo

SetInterfaceInfo

StopProtocol