Función RtmDeleteRouteToDest (rtmv2.h)

Artículo
08/25/2023

La función RtmDeleteRouteToDest elimina una ruta de la tabla de enrutamiento y actualiza la mejor información de ruta para el destino correspondiente, si la mejor ruta ha cambiado. Si cambia la mejor ruta, se genera una notificación de cambio.

Sintaxis

DWORD RtmDeleteRouteToDest(
  [in]  RTM_ENTITY_HANDLE       RtmRegHandle,
  [in]  RTM_ROUTE_HANDLE        RouteHandle,
  [out] PRTM_ROUTE_CHANGE_FLAGS ChangeFlags
);

Parámetros

[in] RtmRegHandle

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

[in] RouteHandle

Identificador de la ruta que se va a eliminar.

[out] ChangeFlags

En la entrada, ChangeFlags es un puntero a RTM_ROUTE_CHANGE_FLAGS tipo de datos.

En la salida, ChangeFlags recibe RTM_ROUTE_CHANGE_BEST marca si se cambió la mejor ruta.

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.
ERROR_NOT_FOUND	No se encontró la ruta especificada.

Comentarios

El routeHandle no debe liberarse posteriormente por un cliente si el cliente ya ha llamado a RtmDeleteRouteToDest mediante ese identificador. La función RtmDeleteRouteToDest elimina la ruta y libera el identificador.

Requisitos


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