Función GetAnycastIpAddressEntry (netioapi.h)

Artículo
02/29/2024

La función GetAnycastIpAddressEntry recupera información de una entrada de dirección IP de anycast existente en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

Parámetros

[in, out] Row

Puntero a una entrada de estructura de MIB_ANYCASTIPADDRESS_ROW para una entrada de dirección IP de difusión. Si la devolución se realiza correctamente, esta estructura se actualizará con las propiedades de una dirección IP de difusión existente.

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
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_ANYCASTIPADDRESS_ROW señalado por el parámetro Row no es un valor en el equipo local.
ERROR_INVALID_PARAMETER	Un parámetro es incorrecto. Este error se devuelve si se pasa un puntero NULL en el parámetro Row , el miembro Address del MIB_ANYCASTIPADDRESS_ROW al que apunta el parámetro Row no está establecido en una dirección IPv4 o IPv6 válida, o bien los miembros InterfaceLuid o InterfaceIndex del MIB_ANYCASTIPADDRESS_ROW 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_ANYCASTIPADDRESS_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 Address de la estructura MIB_ANYCASTIPADDRESS_ROW .
ERROR_NOT_SUPPORTED	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 el miembro Address de la estructura MIB_UNICASTIPADDRESS_ROW apuntada por el parámetro Row . Este error se devuelve si no hay ninguna pila IPv6 en el equipo local y se especifica una dirección IPv6 en el miembro Address .
Otros	Use FormatMessage para obtener la cadena de mensaje para el error devuelto.

Comentarios

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

La función GetAnycastIpAddressEntry se usa para recuperar una entrada de estructura de MIB_ANYCASTIPADDRESS_ROW existente.

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

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

Se puede llamar a la función GetAnycastIpAddressTable para enumerar las entradas de dirección IP de anycast 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