Función RtmBlockDeleteRoutes

[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 RtmBlockDeleteRoutes elimina todas las rutas del subconjunto de rutas especificado de la tabla.

Sintaxis

HANDLE RtmBlockDeleteRoutes(
  _In_ HANDLE ClientHandle,
  _In_ DWORD  EnumerationFlags,
  _In_ PVOID  CriteriaRoute
);

Parámetros

ClientHandle [in]

Controle que identifica al cliente y, por lo tanto, el protocolo de enrutamiento, de las rutas que se van a eliminar.

EnumerationFlags [in]

Especifica qué rutas se deben enumerar. Este parámetro limita el conjunto de rutas eliminadas a un subconjunto definido por las marcas siguientes y los valores de los miembros correspondientes de la estructura a los que apunta el parámetro CriteriaRoute . Las marcas son las mismas que las usadas en RtmCreateEnumerationHandle , excepto que RTM_ONLY_BEST_ROUTES es redundante para RtmBlockDeleteRoutes. La designación de la mejor ruta se ajusta a medida que se eliminan las rutas, por lo que la función elimina finalmente todas las rutas del subconjunto.

CriteriaRoute [in]

Puntero a una estructura de ruta específica de la familia de protocolos ( RTM_IP_ROUTE o RTM_IPX_ROUTE). Los valores de miembro de esta estructura corresponden a las marcas especificadas por el parámetro EnumerationFlags .

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 los mensajes de notificación adecuados para todos los clientes registrados, incluido el autor de la llamada.

Requisitos

Consulte también

Referencia del Administrador de tablas de enrutamiento versión 1

Funciones del Administrador de tablas de enrutamiento versión 1

RtmCreateEnumerationHandle

RtmRegisterClient