PGET_EVENT_MESSAGE コールバック関数 (routprot.h)

[アーティクル]
08/25/2023

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。

要件

要件	値
サポートされている最小のクライアント	サポートなし
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	routprot.h