Partilhar via


Função GetAnycastIpAddressEntry

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

Sintaxe

NETIOAPI_API GetAnycastIpAddressEntry(
  _Inout_ PMIB_ANYCASTIPADDRESS_ROW Row
);

Parâmetros

  • Linha [entrada, saída]
    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 retorna 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. Este erro é retornado se um ponteiro de NULL for passado no parâmetro de linha, o endereço membro da estrutura de MIB_ANYCASTIPADDRESS_ROW para a qual o parâmetro Row aponta não foi definido como um endereço IPv4 ou IPv6 anycast válido, ou ambos InterfaceLuid e InterfaceIndex membros da estrutura MIB_ANYCASTIPADDRESS_ROW não foram especificados.

STATUS_NOT_FOUND

A interface especificada não pôde ser encontrada. Este erro é retornado se a função não conseguir encontrar a interface de rede especificada pelo InterfaceLuid ou InterfaceIndex membro da estrutura de MIB_ANYCASTIPADDRESS_ROW para a qual o parâmetro Row aponta.

STATUS_NOT_SUPPORTED

A solicitação não é suportada. Este 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 para a 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 Address.

Outros

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

Comentários

O função GetAnycastIpAddressEntry é usado para recuperar uma entrada de estrutura de MIB_ANYCASTIPADDRESS_ROW existente.

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

  • Endereço
    Defina como um endereço e família anycast IPv4 ou IPv6 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 foi 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 é bem-sucedida, GetAnycastIpAddressEntry recupera as outras propriedades do endereço IP anycast e preenche a estrutura MIB_ANYCASTIPADDRESS_ROW para a qual o parâmetro Row aponta.

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

Requerimentos

Plataforma de destino

Universal

Versão

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

Cabeçalho

Netioapi.h (inclui Netioapi.h)

Biblioteca

Netio.lib

IRQL

< DISPATCH_LEVEL

Ver também

CreateAnycastIpAddressEntry

DeleteAnycastIpAddressEntry

GetAnycastIpAddressTable

MIB_ANYCASTIPADDRESS_ROW

MIB_ANYCASTIPADDRESS_TABLE