Función RtmUpdateAndUnlockRoute (rtmv2.h)

Artículo
08/25/2023

La función RtmUpdateAndUnlockRoute actualiza la posición de la ruta en el conjunto de rutas de un destino y ajusta la mejor información de ruta para el destino.

Esta función se usa después de que un cliente haya bloqueado una ruta y la haya actualizado directamente (también conocida como actualización local).

Sintaxis

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
);

Parámetros

[in] RtmRegHandle

Identificador del cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] RouteHandle

Identificador de la ruta que se va a cambiar.

[in] TimeToLive

Especifica la hora, en milisegundos, después de la cual la ruta ha expirado. Especifique INFINITE para evitar que expiren las rutas.

[in] RouteListHandle

Controle a una lista de rutas opcional a la que se va a mover la ruta. Este parámetro es opcional y se puede establecer en NULL.

[in] NotifyType

Establezca este parámetro en NULL. NotifyType está reservado para uso futuro.

[in] NotifyHandle

Establezca este parámetro en NULL. NotifyHandle está reservado para uso futuro.

[out] ChangeFlags

Recibe RTM_ROUTE_CHANGE_BEST si se cambió la mejor ruta.

Valor devuelto

Si la función se realiza 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.

Comentarios

Antes de llamar a esta función, el cliente debe bloquear la ruta mediante RtmLockRoute, que devuelve un puntero a la ruta. A continuación, el cliente puede actualizar la información de ruta mediante el puntero. Por último, el cliente debe llamar a RtmUpdateAndUnlockRoute. Si la función se ejecuta correctamente, se desbloquea la ruta. Si se produce un error en la llamada, el cliente debe desbloquear la ruta llamando a RtmLockRoute con el parámetro LockRoute establecido en FALSE.

Para obtener código de ejemplo con esta función, consulte Actualización de una ruta local mediante RtmUpdateAndUnlockRoute.

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