Función GetIpNetEntry2 (netioapi.h)

Artículo
03/15/2023

La función GetIpNetEntry2 recupera información de una entrada de dirección IP vecina en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

Parámetros

[in, out] Row

Puntero a una entrada de estructura MIB_IPNET_ROW2 para una entrada de dirección IP vecina. Si la devolución es correcta, esta estructura se actualizará con las propiedades de la dirección IP vecina.

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.

Código devuelto	Descripción
ERROR_FILE_NOT_FOUND	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_IPNET_ROW2 señalado por el parámetro Row no era un valor en el equipo local.
ERROR_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 miembro Address del MIB_IPNET_ROW2 señalado por el parámetro Row no se estableció en una dirección IPv4 o IPv6 de vecino válida, o los miembros InterfaceLuid o InterfaceIndex del MIB_IPNET_ROW2 señalados por el parámetro Row no se especificaron.
ERROR_NOT_FOUND	Elemento no encontrado. Este error se devuelve si la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex de la estructura MIB_IPNET_ROW2 a la que apunta el parámetro Row no coincide con la dirección IP y la familia de direcciones vecinas especificadas en el miembro Address de la estructura MIB_IPNET_ROW2 .
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 en el equipo local y se especificó una dirección IPv4 en el miembro Address de la estructura MIB_IPNET_ROW2 a la que apunta el parámetro Row . Este error también se devuelve si no hay ninguna pila IPv6 en el equipo local y se especificó una dirección IPv6 en el miembro Address de la estructura MIB_IPNET_ROW2 .
Otros	Use FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

La función GetIpNetEntry2 se define en Windows Vista y versiones posteriores.

La función GetIpNetEntry2 se usa para recuperar una entrada de estructura MIB_IPNET_ROW2 .

En la entrada, el miembro Address de la estructura MIB_IPNET_ROW2 a la que apunta el parámetro Row debe inicializarse en una dirección y familia IPv4 o IPv6 vecina válida. Además, se debe inicializar al menos uno de los siguientes miembros de la estructura MIB_IPNET_ROW2 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 estableció ningún valor para el miembro InterfaceLuid (los valores de este miembro se establecieron en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.

Cuando la llamada se realiza correctamente, GetIpNetEntry2 recupera las demás propiedades de la dirección IP vecina y rellena la estructura de MIB_IPNET_ROW2 a la que apunta el parámetro Row .

Se puede llamar a la función GetIpNetTable2 para enumerar las entradas de dirección IP vecinas 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 (incluya Iphlpapi.h)
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll