Fonction RtmLockDestination (rtmv2.h)

  • Article

La fonction RtmLockDestination verrouille ou déverrouille une destination dans la table de routage. Utilisez cette fonction pour protéger une destination lors de la modification des pointeurs opaques.

Syntaxe

DWORD RtmLockDestination(
  [in] RTM_ENTITY_HANDLE RtmRegHandle,
  [in] RTM_DEST_HANDLE   DestHandle,
  [in] BOOL              Exclusive,
  [in] BOOL              LockDest
);

Paramètres

[in] RtmRegHandle

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

[in] DestHandle

Gérez la destination à verrouiller.

[in] Exclusive

Spécifie s’il faut verrouiller ou déverrouiller la destination en mode exclusif (TRUE) ou partagé (FALSE).

[in] LockDest

Spécifie s’il faut verrouiller ou déverrouiller la destination. Spécifiez TRUE pour verrouiller la destination ; spécifiez FALSE pour le déverrouiller.

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 destination.
ERROR_INVALID_HANDLE
 Le handle n'est pas valide.
 
 

Remarques

Cette fonction verrouille également les routes associées. Évitez de verrouiller les destinations pendant de longues périodes, car aucun autre client ne peut accéder à la destination et aux itinéraires associés tant que le verrou n’est pas libéré.

Un client peut également utiliser cette fonction lors de la lecture d’informations pour une destination, tout en empêchant les modifications pendant l’opération de lecture du client. Dans ce cas, envisagez d’utiliser RtmGetDestInfo à la place.

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

RtmGetOpaqueInformationPointer