Función RtmCreateEnumerationHandle

[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 RtmCreateEnumerationHandle devuelve un identificador para usarlo con RtmEnumerateGetNextRoute para examinar todas las rutas o un subconjunto de rutas, conocidos por el administrador de tablas de enrutamiento.

Sintaxis

HANDLE RtmCreateEnumerationHandle(
  _In_ DWORD ProtocolFamily,
  _In_ DWORD EnumerationFlags,
  _In_ PVOID CriteriaRoute
);

Parámetros

ProtocolFamily [in]

Especifica la familia de protocolos de las rutas que se van a enumerar.

EnumerationFlags [in]

Especifica las rutas que se deben enumerar. Este parámetro limita el conjunto de rutas devueltas por la API de enumeración 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 . Este parámetro puede ser uno de los valores siguientes.

EnumerationFlags	Significado
RTM_ONLY_THIS_NETWORK	Enumere solo las rutas que tienen el mismo número de red que el miembro RR_Network de la estructura a la que apunta CriteriaRoute.
RTM_ONLY_THIS_INTERFACE	Enumere solo las rutas que se obtuvieron a través de la interfaz especificada por el campo RR_InterfaceID de la estructura a la que apunta CriteriaRoute.
RTM_ONLY_THIS_PROTOCOL	Enumere solo las rutas agregadas por el protocolo de enrutamiento especificado por el campo RR_RoutingProtocol de la estructura a la que apunta CriteriaRoute.
RTM_ONLY_BEST_ROUTES	Enumere solo las mejores rutas a cada una de las redes del conjunto.

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 un HANDLE que se va a usar con llamadas de enumeración posteriores.

Si se produce un error en la función o no existen rutas con los criterios especificados, el valor devuelto es NULL. Llame a GetLastError para obtener más información.

Requisitos

Consulte también

Referencia de la versión 1 del Administrador de tablas de enrutamiento

Funciones del Administrador de tablas de enrutamiento versión 1

GetLastError

RTM_IP_ROUTE

RTM_IPX_ROUTE

RtmCloseEnumerationHandle

RtmEnumerateGetNextRoute