Fonction RtmHoldDestination (rtmv2.h)

Article
03/04/2024

La fonction RtmHoldDestination marque une destination à placer dans l’état de conservation pendant un certain laps de temps. Une conservation se produit uniquement si la dernière route pour la destination dans une vue est supprimée.

Les protocoles de routage qui utilisent des états d’attente continuent de publier la dernière route jusqu’à l’expiration de la conservation, même si des itinéraires plus récents arrivent entre-temps. L’itinéraire est publié en tant qu’itinéraire supprimé. Toutefois, les itinéraires les plus récents sont utilisés par les protocoles de routage à des fins de transfert. De nouveaux itinéraires sont publiés lorsque la conservation expire.

Syntaxe

DWORD RtmHoldDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] RTM_VIEW_SET      TargetViews,
  [in] ULONG             HoldTime
);

Paramètres

[in] RtmRegHandle

Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.

[in] DestHandle

Handle vers la destination à marquer pour la conservation.

[in] TargetViews

Spécifie les vues dans lesquelles contenir la destination.

[in] HoldTime

Spécifie la durée, en millisecondes, de conservation de la destination.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Signification
ERROR_INVALID_PARAMETER	L’heure de conservation spécifiée était égale à zéro.
ERROR_INVALID_HANDLE	Le handle n'est pas valide.

Remarques

Tous les itinéraires dans un état de conservation sont conservés pour toutes les vues pendant une durée d’attente maximale unique, quelle que soit la durée de conservation spécifiée.

Pour obtenir un exemple de code utilisant cette fonction, consultez Utiliser l’état Hold-Down route.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	rtmv2.h
Bibliothèque	Rtm.lib
DLL	Rtm.dll

Voir aussi

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmLockRoute

RtmUpdateAndUnlockRoute

Partager via