Compartilhar via


Função GetAnycastIpAddressEntry

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

Sintaxe

NETIOAPI_API GetAnycastIpAddressEntry(
  _Inout_ PMIB_ANYCASTIPADDRESS_ROW Row
);

Parâmetros

  • linha [dentro, fora]
    Um ponteiro para uma entrada de estrutura MIB_ANYCASTIPADDRESS_ROW para uma entrada de endereço IP anycast. No retorno bem-sucedido, essa estrutura é atualizada com as propriedades de um endereço IP anycast existente.

Valor de retorno

GetAnycastIpAddressEntry retornará STATUS_SUCCESS se a função for bem-sucedida.

Se a função falhar, GetAnycastIpAddressEntry retornará um dos seguintes códigos de erro:

Código de retorno Descrição
STATUS_INVALID_PARAMETER

Um parâmetro inválido foi passado para a função. Esse erro será retornado se um ponteiro NULL for passado no parâmetro linha, o de Endereço membro da estrutura MIB_ANYCASTIPADDRESS_ROW à qual o parâmetro de Linha aponta não foi definido como um endereço IPv4 ou IPv6 válido ou InterfaceLuid e InterfaceIndex da estrutura MIB_ANYCASTIPADDRESS_ROW não foram especificados.

STATUS_NOT_FOUND

Não foi possível encontrar a interface especificada. Esse erro será retornado se a função não puder encontrar a interface de rede especificada pelo InterfaceLuid ou interfaceIndex membro da estrutura MIB_ANYCASTIPADDRESS_ROW à qual o parâmetro Row aponta.

STATUS_NOT_SUPPORTED

Não há suporte para a solicitação. Esse erro será retornado se nenhuma pilha IPv4 estiver localizada no computador local e um endereço IPv4 tiver sido especificado no Address membro da estrutura MIB_UNICASTIPADDRESS_ROW à qual o parâmetro Row aponta ou se nenhuma pilha IPv6 estiver localizada no computador local e um endereço IPv6 tiver sido especificado no membro endereço.

Outros

Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Observações

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

Na entrada, o driver deve inicializar os seguintes membros da estrutura MIB_ANYCASTIPADDRESS_ROW à qual o parâmetro Row aponta.

  • endereço
    Defina como um endereço IPv4 ou IPv6 anycast e uma família válidos.

  • InterfaceLuid ou interfaceIndex
    Esses membros são usados na ordem listada anteriormente. Portanto, se InterfaceLuid for especificado, esse membro será usado para determinar a interface. Se nenhum valor tiver sido definido para o membro InterfaceLuid (o valor desse membro foi definido como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

Na saída, quando a chamada for bem-sucedida, GetAnycastIpAddressEntry recuperará as outras propriedades para o endereço IP anycast e preencherá a estrutura de MIB_ANYCASTIPADDRESS_ROW à qual o parâmetro Linha aponta.

O driver pode chamar a função GetAnycastIpAddressTable para enumerar as entradas de endereço IP anycast em um computador local.

Requisitos

Plataforma de destino

Universal

Versão

Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.

Cabeçalho

Netioapi.h (inclua Netioapi.h)

Biblioteca

Netio.lib

IRQL

< DISPATCH_LEVEL

Consulte também

CreateAnycastIpAddressEntry

DeleteAnycastIpAddressEntry

GetAnycastIpAddressTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE