Función RtmDeleteRoute

[Esta API se ha reemplazado por la API del Administrador de tablas de enrutamiento versión 2 y no estará disponible más allá de Windows Server 2003. Las aplicaciones deben usar la API routing Table Manager versión 2.]

La función RtmDeleteRoute elimina una entrada de ruta.

Sintaxis

DWORD RtmDeleteRoute(
  _In_  HANDLE ClientHandle,
  _In_  PVOID  Route,
  _Out_ DWORD  Flags,
  _Out_ PVOID  CurBestRoute
);

Parámetros

ClientHandle [in]

Identificador que identifica al cliente y, por tanto, el protocolo de enrutamiento de la ruta agregada o actualizada. Obtenga este identificador llamando a RtmRegisterClient.

Ruta [in]

Puntero a una estructura específica de la familia de protocolos que especifica la ruta nueva o actualizada. El administrador de tablas de enrutamiento usa los siguientes campos para actualizar la tabla de enrutamiento:

Valor	Significado
RR_Network	Especifica el número de red de destino.
RR_InterfaceID	Especifica el índice de la interfaz a través de la cual se recibió la ruta.
RR_NextHopAddress	Especifica la dirección de red del enrutador de próximo salto.

Marcas [out]

Puntero a un conjunto de marcas que indican el tipo del mensaje de cambio y qué información se colocó en los búferes proporcionados. Este parámetro es uno de los valores siguientes.

Marcas	Significado
RTM_NO_CHANGE	La eliminación de la ruta no afectaba a la mejor ruta a cualquier red de destino. En otras palabras, otra entrada representa una ruta a la misma red de destino y tiene una métrica inferior.
RTM_ROUTE_DELETED	La ruta eliminada era la única ruta disponible para una red de destino determinada.
RTM_ROUTE_CHANGED	Después de eliminar esta ruta, otra ruta se convirtió en la mejor ruta a una red de destino determinada. CurBestRoute apunta a la información de la nueva mejor ruta.

CurBestRoute [out]

Puntero a una estructura que recibe la información de la mejor ruta actual, si existe. El tipo de la estructura es específico de la familia de protocolos, por ejemplo, IP o IPX.

Este parámetro es opcional. Si el autor de la llamada especifica NULL para este parámetro, no se devuelve la información de la mejor ruta actual.

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.

Comentarios

La función genera un mensaje de cambio de ruta si la mejor ruta a una red de destino ha cambiado como resultado de la eliminación. Sin embargo, el mensaje de cambio de ruta no se envía al cliente que realiza esta llamada. En su lugar, esta función devuelve información relevante directamente a ese cliente.

Requisitos

Consulte también

Referencia del Administrador de tablas de enrutamiento versión 1

Funciones del Administrador de tablas de enrutamiento versión 1

RtmAddRoute

RtmDequeueRouteChangeMessage