Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
[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 RtmGetFirstRoute devuelve la primera ruta del subconjunto especificado de rutas de la tabla.
Sintaxis
DWORD RtmGetFirstRoute(
_In_ DWORD ProtocolFamily,
_In_ DWORD EnumerationFlags,
_Inout_ PVOID Route
);
Parámetros
-
ProtocolFamily [in]
-
Especifica la familia de protocolos de rutas que se van a recuperar, por ejemplo, IP o IPX.
-
EnumerationFlags [in]
-
Especifica los límites del conjunto de rutas eliminadas a un subconjunto definido por estas marcas 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.
-
Ruta [dentro, fuera]
-
En la entrada, Route apunta a una estructura específica de la familia de protocolos ( RTM_IP_ROUTE o RTM_IPX_ROUTE).
La función de llamada proporciona valores de miembro para esta estructura. Estos valores, junto con el parámetro EnumerationFlags , especifican el conjunto desde el que se van a devolver rutas.
Salida, Route apunta a la primera ruta que coincidía con los criterios especificados.
Valor devuelto
Si la función se realiza 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.
| Value | Descripción |
|---|---|
|
Uno de los parámetros no es válido. |
|
No hay rutas que coincidan con los criterios especificados. |
|
No hay recursos suficientes para llevar a cabo la operación. |
Comentarios
Las rutas se devuelven en el orden siguiente:
- Número de red
- Protocolo de enrutamiento
- Identificador de interfaz
- Dirección del próximo salto
Esta función es menos eficaz que la función de identificador de enumeración correspondiente, RtmEnumerateGetNextRoute.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible |
No se admite ninguno |
| Servidor mínimo compatible |
Windows 2000 Server [solo aplicaciones de escritorio] |
| Fin de compatibilidad de servidor |
Windows Server 2003 |
| Encabezado |
|
| Biblioteca |
|
| Archivo DLL |
|