RtmHoldDestination 関数 (rtmv2.h)
RtmHoldDestination 関数は、一定の時間、保留状態になる宛先をマークします。 保留は、ビュー内の宛先の最後のルートが削除された場合にのみ発生します。
保留状態を使用するルーティング プロトコルは、その間に新しいルートが到着した場合でも、ホールドダウンの有効期限が切れるまで最後のルートをアドバタイズし続けます。 ルートは削除されたルートとしてアドバタイズされます。 ただし、新しいルートは、転送のためにルーティング プロトコルによって使用されます。 保留が切れると、新しいルートがアドバタイズされます。
構文
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
パラメーター
[in] RtmRegHandle
RtmRegisterEntity の以前の呼び出しから取得したクライアントを処理します。
[in] DestHandle
保持するマークを付ける宛先にハンドルします。
[in] TargetViews
変換先を保持するビューを指定します。
[in] HoldTime
宛先を保持する時間をミリ秒単位で指定します。
戻り値
関数が成功した場合、戻り値はNO_ERROR。
関数が失敗した場合、戻り値は次のいずれかのエラー コードになります。
| 値 | 意味 |
|---|---|
|
指定された保留時間は 0 でした。 |
|
ハンドルが正しくありません。 |
注釈
保留状態のすべてのルートは、指定された HoldTime に関係なく、1 つの最大ホールドダウン時間のすべてのビューに対して保持されます。
この関数を使用するサンプル コードについては、「 Route Hold-Down State を使用する」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | サポートなし |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | rtmv2.h |
| Library | Rtm.lib |
| [DLL] | Rtm.dll |