Función RtmHoldDestination (rtmv2.h)

La función RtmHoldDestination marca un destino que se va a colocar en el estado de suspensión durante una determinada cantidad de tiempo. Una suspensión solo se produce si se elimina la última ruta del destino en cualquier vista.

Los protocolos de enrutamiento que usan estados de suspensión continúan anunciando la última ruta hasta que expire la suspensión, incluso si las rutas más recientes llegan mientras tanto. La ruta se anuncia como una ruta eliminada. Sin embargo, las rutas más recientes se usan en los protocolos de enrutamiento con fines de reenvío. Las nuevas rutas se anuncian cuando expira la suspensión.

Sintaxis

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

Parámetros

[in] RtmRegHandle

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

[in] DestHandle

Controle al destino que se va a marcar para mantenerla.

[in] TargetViews

Especifica las vistas en las que se va a contener el destino.

[in] HoldTime

Especifica cuánto tiempo, en milisegundos, se almacenará el destino.

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_INVALID_PARAMETER	El tiempo de retención especificado era cero.
ERROR_INVALID_HANDLE	El identificador no es válido.

 

 

Comentarios

Todas las rutas en estado de suspensión se mantienen para todas las vistas durante un tiempo de espera único y máximo, independientemente del valor de HoldTime especificado.

Para obtener código de ejemplo con esta función, consulte Uso del estado de route Hold-Down.

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

Consulte también

RtmAddRouteToDest

RtmDeleteRouteToDest

RtmLockRoute

RtmUpdateAndUnlockRoute