Função GetAnycastIpAddressEntry (netioapi.h)

Artigo
08/25/2023

A função GetAnycastIpAddressEntry recupera informações para uma entrada de endereço IP anycast existente no computador local.

Sintaxe

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

Parâmetros

[in, out] Row

Um ponteiro para uma entrada de estrutura MIB_ANYCASTIPADDRESS_ROW para uma entrada de endereço IP anycast. No retorno bem-sucedido, essa estrutura será atualizada com as propriedades de um endereço IP anycast existente.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos códigos de erro a seguir.

Código de retorno	Descrição
ERROR_FILE_NOT_FOUND	O sistema não pode encontrar o arquivo especificado. Esse erro será retornado se o LUID da interface de rede ou o índice de interface especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_ANYCASTIPADDRESS_ROW apontado pelo parâmetro Row não for um valor no computador local.
ERROR_INVALID_PARAMETER	Um parâmetro está incorreto. Esse erro será retornado se um ponteiro NULL for passado no parâmetro Row , o membro Address do MIB_ANYCASTIPADDRESS_ROW apontado pelo parâmetro Row não for definido como um endereço IPv4 ou IPv6 de anycast válido ou os membros InterfaceLuid ou InterfaceIndex do MIB_ANYCASTIPADDRESS_ROW apontados pelo parâmetro Row não foram especificados.
ERROR_NOT_FOUND	Elemento não encontrado. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_ANYCASTIPADDRESS_ROW apontada pelo parâmetro Row não corresponder ao endereço IP e à família de endereços especificados no membro Address na estrutura MIB_ANYCASTIPADDRESS_ROW .
ERROR_NOT_SUPPORTED	A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local e um endereço IPv4 for especificado no membro Address da estrutura MIB_UNICASTIPADDRESS_ROW apontada pelo parâmetro Row . Esse erro será retornado se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 for especificado no membro Address .
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetAnycastIpAddressEntry é definida no Windows Vista e posterior.

A função GetAnycastIpAddressEntry é usada para recuperar uma entrada de estrutura MIB_ANYCASTIPADDRESS_ROW existente.

Na entrada, o membro Address na estrutura MIB_ANYCASTIPADDRESS_ROW apontada pelo parâmetro Row deve ser inicializado para um endereço e família IPv4 ou IPv6 válidos. Além disso, pelo menos um dos seguintes membros na estrutura MIB_ANYCASTIPADDRESS_ROW apontado para o parâmetro Row deve ser inicializado: InterfaceLuid ou InterfaceIndex.

Os campos são usados na ordem listada acima. Portanto, se InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor for definido para o membro InterfaceLuid (o valor desse membro é definido como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

Na saída quando a chamada é bem-sucedida, GetAnycastIpAddressEntry recupera as outras propriedades para o endereço IP anycast e preenche a estrutura MIB_ANYCASTIPADDRESS_ROW apontada pelo parâmetro Row .

A função GetAnycastIpAddressTable pode ser chamada para enumerar as entradas de endereço IP anycast em um computador local.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	netioapi.h (inclua Iphlpapi.h)
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll