RtmDeleteRouteToDest 関数 (rtmv2.h)
RtmDeleteRouteToDest 関数は、ルーティング テーブルからルートを削除し、最適なルートが変更された場合に、対応する宛先の最適なルート情報を更新します。 最適なルートが変更されると、変更通知が生成されます。
構文
DWORD RtmDeleteRouteToDest(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_ROUTE_HANDLE RouteHandle,
[out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);
パラメーター
[in] RtmRegHandle
RtmRegisterEntity の以前の呼び出しから取得したクライアントを処理します。
[in] RouteHandle
削除するルートを処理します。
[out] ChangeFlags
入力時、 ChangeFlags は RTM_ROUTE_CHANGE_FLAGS データ型へのポインターです。
出力時に、最適なルートが変更された場合、 ChangeFlags は RTM_ROUTE_CHANGE_BEST フラグを受け取ります。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 説明 |
|---|---|
|
呼び出し元のクライアントはこのルートを所有していません。 |
|
ハンドルが正しくありません。 |
|
指定されたルートが見つかりませんでした。 |
解説
クライアントがそのハンドルを使用して RtmDeleteRouteToDest を既に呼び出している場合、RouteHandle はクライアントによって解放されません。 RtmDeleteRouteToDest 関数はルートを削除し、ハンドルを解放します。
要件
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | rtmv2.h |
| Library | Rtm.lib |
| [DLL] | Rtm.dll |