Función RtmLockRoute (rtmv2.h)

Artículo
03/01/2024

La función RtmLockRoute bloquea o desbloquea una ruta en la tabla de enrutamiento. Esto protege la ruta mientras un cliente realiza los cambios necesarios en los punteros de ruta opacos que pertenecen al cliente.

Sintaxis

DWORD RtmLockRoute(
  [in]  RTM_ENTITY_HANDLE RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE  RouteHandle,
  [in]  BOOL              Exclusive,
  [in]  BOOL              LockRoute,
  [out] PRTM_ROUTE_INFO   *RoutePointer
);

Parámetros

[in] RtmRegHandle

Identificador para el cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] RouteHandle

Controle la ruta al bloqueo.

[in] Exclusive

Especifica si se va a bloquear o desbloquear la ruta en un modo exclusivo (TRUE) o compartido (FALSE).

[in] LockRoute

Especifica si se va a bloquear o desbloquear la ruta. Especifique TRUE para bloquear la ruta; especifique FALSE para desbloquearlo.

[out] RoutePointer

Si se debe devolver un puntero: en la entrada, RoutePointer es un puntero a NULL. En la salida, si el cliente posee la ruta, RoutePointer recibe un puntero al próximo salto; de lo contrario, RoutePointer permanece sin cambios.

Si no es necesario devolver un identificador: en la entrada, RoutePointer es NULL.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor	Significado
ERROR_ACCESS_DENIED	El cliente que realiza la llamada no posee esta ruta.
ERROR_INVALID_HANDLE	El identificador no es válido.

Comentarios

No llame a ninguna otra función RTMv2 hasta que la ruta se desbloquee mediante una llamada a RtmLockRoute y el parámetro LockRoute esté establecido en FALSE o en una llamada a RtmUpdateAndUnlockRoute.

Actualmente, esta función bloquea todo el destino, no solo la ruta.

Los clientes solo pueden cambiar los miembros Vecino, PrefInfo, BelongsToViews, EntitySpecificInfo y NextHopsList de la estructura RTM_ROUTE_INFO .

Si se cambia alguno de estos valores, el cliente debe llamar a RtmUpdateAndUnlockRoute para notificar al administrador de tablas de enrutamiento de los cambios.

Requisitos

Requisito	Value
Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	rtmv2.h
Library	Rtm.lib
Archivo DLL	Rtm.dll