Fonction RtmUpdateAndUnlockRoute (rtmv2.h)

Article
03/04/2024

La fonction RtmUpdateAndUnlockRoute met à jour la position de l’itinéraire dans l’ensemble des itinéraires d’une destination et ajuste les meilleures informations d’itinéraire pour la destination.

Cette fonction est utilisée après qu’un client a verrouillé une route et l’a mise à jour directement (également appelée mise à jour sur place).

Syntaxe

DWORD RtmUpdateAndUnlockRoute(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [in]  ULONG                   TimeToLive,
  [in]  RTM_ROUTE_LIST_HANDLE   RouteListHandle,
  [in]  RTM_NOTIFY_FLAGS        NotifyType,
  [in]  RTM_NOTIFY_HANDLE       NotifyHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

Paramètres

[in] RtmRegHandle

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

[in] RouteHandle

Gérez l’itinéraire à modifier.

[in] TimeToLive

Spécifie l’heure, en millisecondes, après laquelle l’itinéraire a expiré. Spécifiez INFINITE pour empêcher l’expiration des itinéraires.

[in] RouteListHandle

Gérez vers une liste de routes facultative vers laquelle déplacer l’itinéraire. Ce paramètre est facultatif et peut être défini sur NULL.

[in] NotifyType

Définissez ce paramètre sur NULL. NotifyType est réservé à une utilisation ultérieure.

[in] NotifyHandle

Définissez ce paramètre sur NULL. NotifyHandle est réservé à une utilisation ultérieure.

[out] ChangeFlags

Reçoit RTM_ROUTE_CHANGE_BEST si le meilleur itinéraire a été modifié.

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_ACCESS_DENIED	Le client appelant ne possède pas cette route.

Remarques

Avant d’appeler cette fonction, le client doit verrouiller l’itinéraire à l’aide de RtmLockRoute, qui retourne un pointeur vers l’itinéraire. Ensuite, le client peut mettre à jour les informations d’itinéraire à l’aide du pointeur. Enfin, le client doit appeler RtmUpdateAndUnlockRoute. Si la fonction s’exécute correctement, l’itinéraire est déverrouillé. Si l’appel a échoué, le client doit déverrouiller l’itinéraire en appelant RtmLockRoute avec le paramètre LockRoute défini sur FALSE.

Pour obtenir un exemple de code utilisant cette fonction, consultez Mettre à jour un itinéraire en place à l’aide de RtmUpdateAndUnlockRoute.

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

Partager via