Función GetIpPathEntry (netioapi.h)
La función GetIpPathEntry recupera información de una entrada de ruta de acceso IP en el equipo local.
Sintaxis
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpPathEntry(
[in, out] PMIB_IPPATH_ROW Row
);
Parámetros
[in, out] Row
Puntero a una entrada de estructura de MIB_IPPATH_ROW para una entrada de ruta de acceso IP. Si la devolución se realiza correctamente, esta estructura se actualizará con las propiedades de la entrada de ruta de acceso IP.
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.
| Código devuelto | Descripción |
|---|---|
|
El sistema no encuentra el archivo especificado. Este error se devuelve si el luid de interfaz de red o el índice de interfaz especificado por el miembro InterfaceLuid o InterfaceIndex del MIB_IPPATH_ROW señalado por el parámetro Row no es un valor en el equipo local. |
|
Un parámetro es incorrecto. Este error se devuelve si se pasa un puntero NULL en el parámetro Row , el miembro si_family del miembro Destination del MIB_IPPATH_ROW señalado por el parámetro Row no está establecido en AF_INET o AF_INET6, o bien los miembros InterfaceLuid o InterfaceIndex del MIB_IPPATH_ROW señalados por el parámetro Row no se especifican. Este error también se devuelve si el miembro si_family en el miembro Source del MIB_IPPATH_ROW al que apunta el parámetro Row no coincide con la familia de direcciones IP de destino y el si_family de la dirección IP de origen no se especifica como AF_UNSPEC. |
|
Elemento no encontrado. Este error se devuelve si 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 no coincide con la dirección IP y la familia de direcciones especificadas en el miembro Destination de la estructura MIB_IPPATH_ROW . |
|
No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 en el equipo local y se especifica una dirección IPv4 en los miembros Source y Destination del MIB_IPPATH_ROW apunta el parámetro Row . Este error también se devuelve si no hay ninguna pila IPv6 en el equipo local y se especifica una dirección IPv6 en los miembros origen y destino . |
|
Use FormatMessage para obtener la cadena de mensaje para el error devuelto. |
Comentarios
La función GetIpPathEntry se define en Windows Vista y versiones posteriores.
La función GetIpPathEntry se usa para recuperar una entrada de estructura MIB_IPPATH_ROW .
En la entrada, el miembro Destination de la estructura MIB_IPPATH_ROW a la que apunta el parámetro Row debe inicializarse en una dirección y familia IPv4 o IPv6 válidas. La familia de direcciones especificada en el miembro Source de la estructura MIB_IPPATH_ROW también debe coincidir con la familia de direcciones IP de destino especificada en el miembro Destination o la familia de direcciones del miembro Source debe especificarse como AF_UNSPEC. Además, se debe inicializar al menos uno de los miembros siguientes de la estructura MIB_IPPATH_ROW que apunta al parámetro Row : InterfaceLuid o InterfaceIndex.
Los campos se usan en el orden indicado anteriormente. Por lo tanto, si se especifica InterfaceLuid , este miembro se usa para determinar la interfaz. Si no se establece ningún valor para el miembro InterfaceLuid (los valores de este miembro se establecen en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.
Cuando la llamada se realiza correctamente, GetIpPathEntry recupera las demás propiedades de la entrada de ruta de acceso IP y rellena la estructura de MIB_IPPATH_ROW a la que apunta el parámetro Row .
Se puede llamar a la función GetIpPathTable para enumerar las entradas de ruta de acceso IP en un equipo local.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Windows Vista [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows Server 2008 [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | netioapi.h (include Iphlpapi.h) |
| Library | Iphlpapi.lib |
| Archivo DLL | Iphlpapi.dll |