Función GetIpPathTable
La función GetIpPathEntry recupera información de una entrada de ruta de acceso IP en un equipo local.
Sintaxis
NETIOAPI_API GetIpPathTable(
_In_ ADDRESS_FAMILY Family,
_Out_ PMIB_IPPATH_TABLE *Table
);
Parámetros
Familia [in]
Familia de direcciones que se va a recuperar.Los valores posibles para la familia de direcciones se enumeran en el archivo de encabezado Winsock2.h. Tenga en cuenta que los valores de la familia de direcciones AF_ y las constantes de familia de protocolos de PF_ son idénticas (por ejemplo, AF_INET y PF_INET), por lo que puede usar cualquiera de las constantes.
En Windows Vista y versiones posteriores de los sistemas operativos Windows, los valores posibles para el parámetro Family se definen en el archivo de encabezado Ws2def.h. Tenga en cuenta que el archivo de encabezado Ws2def.h se incluye automáticamente en Netioapi.h y nunca debe usar Ws2def.h directamente.
Actualmente se admiten los siguientes valores para la familia de direcciones:
AF_INET
Familia de direcciones IPv4. Cuando se especifica este valor, esta función devuelve la tabla de ruta de acceso IP que contiene solo entradas IPv4.AF_INET6
Familia de direcciones IPv6. Cuando se especifica este valor, esta función devuelve la tabla de ruta de acceso IP que contiene solo entradas IPv6.AF_UNSPEC
No se especifica la familia de direcciones. Cuando se especifica este valor, esta función devuelve la tabla de ruta de acceso IP que contiene entradas IPv4 e IPv6.
Tabla [salida]
Puntero a una estructura de MIB_IPPATH_TABLE que contiene una tabla de entradas de ruta de acceso IP en el equipo local.
Valor devuelto
GetIpPathEntry devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, GetIpPathEntry devuelve uno de los siguientes códigos de error:
| Código devuelto | Descripción |
|---|---|
| STATUS_INVALID_PARAMETER | Se pasó un parámetro no válido a la función. Este error se devuelve si se pasa un puntero NULL en el parámetro Table o el parámetro Family no se especificó como AF_INET, AF_INET6 o AF_UNSPEC. |
| STATUS_NOT_ENOUGH_MEMORY | Los recursos de memoria insuficientes están disponibles para completar la operación. |
| STATUS_NOT_FOUND | No se encontraron entradas de ruta de acceso IP, como se especifica en el parámetro Family . |
| STATUS_NOT_SUPPORTED | No se admite la solicitud. Este error se devuelve si no se encuentra ninguna pila IPv4 en el equipo local y AF_INET se especificó en el parámetro Family , o si no se encuentra ninguna pila IPv6 en el equipo local y AF_INET6 se especificó en el parámetro Family . Este error también se devuelve en las versiones de Windows en las que no se admite esta función. |
| Otros | Use la función FormatMessage para obtener la cadena de mensaje para el error devuelto. |
Observaciones
La función GetIpPathTable enumera las entradas de ruta de acceso IP en un equipo local y devuelve esta información en una estructura de MIB_IPPATH_TABLE .
GetIpPathTable devuelve las entradas de ruta de acceso IP de una estructura de MIB_IPPATH_TABLE en el búfer al que apunta el parámetro Table . La estructura MIB_IPPATH_TABLE contiene un recuento de entradas de ruta de acceso IP y una matriz de estructuras de MIB_IPPATH_ROW para cada entrada de ruta de acceso IP. Cuando estas estructuras devueltas ya no son necesarias, el controlador debe liberar la memoria llamando a FreeMibTable.
El controlador debe inicializar el parámetro Family en AF_INET, AF_INET6 o AF_UNSPEC.
Tenga en cuenta que la estructura de MIB_IPPATH_TABLE devuelta a la que apunta el parámetro Table podría contener relleno para la alineación entre el miembro NumEntries y la primera entrada de matriz MIB_IPPATH_ROW en el miembro Table de la estructura MIB_IPPATH_TABLE. El relleno para la alineación también puede estar presente entre las entradas de matriz de MIB_IPPATH_ROW. Cualquier acceso a una entrada de matriz de MIB_IPPATH_ROW debe suponer que puede existir relleno.
Requisitos
Plataforma de destino |
Universal |
Versión |
Disponible en Windows Vista y versiones posteriores de los sistemas operativos Windows. |
Encabezado |
Netioapi.h (incluya Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |