RtmHoldDestination-Funktion (rtmv2.h)
Die RtmHoldDestination-Funktion markiert ein Ziel, das für einen bestimmten Zeitraum in den Haltezustand versetzt werden soll. Ein Haltevorgang erfolgt nur, wenn die letzte Route für das Ziel in einer Ansicht gelöscht wird.
Routingprotokolle, die den Status "Holddown" verwenden, kündigen weiterhin die letzte Route an, bis der Haltevorgang abläuft, auch wenn neuere Routen in der Zwischenzeit eintreffen. Die Route wird als gelöschte Route angekündigt. Die neueren Routen werden jedoch von den Routingprotokollen zu Weiterleitungszwecken verwendet. Neue Routen werden angekündigt, wenn der Haltedown abläuft.
Syntax
DWORD RtmHoldDestination(
[in] RTM_ENTITY_HANDLE RtmRegHandle,
[in] RTM_DEST_HANDLE DestHandle,
[in] RTM_VIEW_SET TargetViews,
[in] ULONG HoldTime
);
Parameter
[in] RtmRegHandle
Handle an den Client, der von einem vorherigen Aufruf von RtmRegisterEntity abgerufen wurde.
[in] DestHandle
Handle bis zum Ziel, das zum Halten markiert werden soll.
[in] TargetViews
Gibt die Ansichten an, in denen das Ziel enthalten sein soll.
[in] HoldTime
Gibt an, wie lange das Ziel in Millisekunden gehalten werden soll.
Rückgabewert
Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.
Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.
| Wert | Bedeutung |
|---|---|
|
Die angegebene Haltezeit war null. |
|
Das Handle ist ungültig. |
Hinweise
Alle Routen in einem Haltezustand werden für alle Ansichten für eine einzelne, maximale Haltezeit gehalten, unabhängig von der angegebenen HoldTime .
Beispielcode mit dieser Funktion finden Sie unter Verwenden des Route Hold-Down State.
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) | Nicht unterstützt |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | rtmv2.h |
| Bibliothek | Rtm.lib |
| DLL | Rtm.dll |