Función GetIpPathEntry
La función GetIpPathEntry recupera información de una entrada de ruta de acceso IP en un equipo local.
Sintaxis
NETIOAPI_API GetIpPathEntry(
_Inout_ PMIB_IPPATH_ROW Row
);
Parámetros
- Fila [in, out]
Puntero a una entrada de estructura MIB_IPPATH_ROW para una entrada de ruta de acceso IP. Si la devolución es correcta, esta estructura se actualiza con las propiedades de la entrada de ruta de acceso IP.
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 Row , el si_family miembro del miembro Destination de la estructura MIB_IPPATH_ROW a la que el parámetro Row apunta no se estableció en AF_INET o AF_INET6, o los miembros InterfaceLuid e InterfaceIndex de la estructura de MIB_IPPATH_ROW no se especificaron. Este error también se devuelve si el miembro si_family del miembro Source de la estructura MIB_IPPATH_ROW no coincide con la familia de direcciones IP de destino y el si_family de la dirección IP de origen no se especificó como AF_UNSPEC. |
| STATUS_NOT_FOUND | No se encontró la interfaz especificada. Este error se devuelve si la función no encuentra la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex de la estructura MIB_IPPATH_ROW a la que apunta el parámetro Row . |
| STATUS_NOT_SUPPORTED | No se admite la solicitud. Este error se devuelve si no se encuentra ninguna pila IPv4 en el equipo local y se especificó una dirección IPv4 en los miembros Source y Destination de la estructura MIB_IPPATH_ROW a la que apunta el parámetro Row , o si no se encuentra ninguna pila IPv6 en el equipo local y se especificó una dirección IPv6 en los miembros Source y Destination . |
| Otros | Use la función FormatMessage para obtener la cadena de mensaje del error devuelto. |
Observaciones
La función GetIpPathEntry se usa para recuperar una entrada de estructura MIB_IPPATH_ROW .
En la entrada, el controlador debe inicializar los siguientes miembros de la estructura MIB_IPPATH_ROW a la que apunta el parámetro Row .
Destino
Establézcalo en una dirección y familia IPv4 o IPv6 válida.Origen
Establezca la familia de direcciones especificada en el miembro Source en la familia de direcciones IP de destino especificada en el miembro Destination o en AF_UNSPEC.InterfaceLuid o InterfaceIndex
Estos miembros se usan en el orden que se muestra anteriormente. Por lo tanto, si se especifica InterfaceLuid , este miembro se usa para determinar la interfaz. Si no se estableció ningún valor para el miembro InterfaceLuid (el valor de este miembro se estableció en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.
En la salida, cuando la llamada se realiza correctamente, GetIpPathEntry recupera las demás propiedades de la entrada de ruta de acceso IP y rellena la estructura MIB_IPPATH_ROW a la que apunta el parámetro Row .
El controlador puede llamar a la función GetIpPathTable para enumerar las entradas de la ruta de acceso IP en un equipo local.
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 |