Compartilhar via


Função GetUnicastIpAddressEntry

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

Sintaxe

NETIOAPI_API GetUnicastIpAddressEntry(
  _Inout_ PMIB_UNICASTIPADDRESS_ROW Row
);

Parâmetros

  • Linha [entrada, saída]
    Um ponteiro para uma entrada de estrutura MIB_UNICASTIPADDRESS_ROW para uma entrada de endereço IP unicast. No retorno bem-sucedido, essa estrutura é atualizada com as propriedades de um endereço IP unicast existente.

Retornar valor

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

Se a função falhar, GetUnicastIpAddressEntry 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 Row , o membro Address da estrutura MIB_UNICASTIPADDRESS_ROW para a qual o parâmetro Row aponta não foi definido como um endereço IPv4 ou IPv6 unicast válido ou os membros InterfaceLuid e InterfaceIndex da estrutura MIB_UNICASTIPADDRESS_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 o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex da estrutura MIB_UNICASTIPADDRESS_ROW para a qual o parâmetro Row aponta.

STATUS_NOT_SUPPORTED

A solicitação não terá suporte. Esse erro será retornado se nenhuma pilha IPv4 estiver localizada no computador local e um endereço IPv4 tiver sido especificado no membro Address 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

A função GetUnicastIpAddressEntry normalmente é usada para recuperar uma entrada de estrutura de MIB_UNICASTIPADDRESS_ROW existente a ser modificada. Em seguida, um driver pode alterar os membros na entrada MIB_UNICASTIPADDRESS_ROW que deseja modificar e, em seguida, chamar a função SetUnicastIpAddressEntry .

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

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

  • 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, GetUnicastIpAddressEntry recuperará as outras propriedades para o endereço IP unicast e preencherá a estrutura MIB_UNICASTIPADDRESS_ROW para a qual o parâmetro Row aponta.

Seu driver pode chamar a função GetUnicastIpAddressTable para enumerar as entradas de endereço IP unicast 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

Confira também

CreateUnicastIpAddressEntry

DeleteUnicastIpAddressEntry

GetUnicastIpAddressTable

InitializeUnicastIpAddressEntry

MIB_UNICASTIPADDRESS_ROW

MIB_UNICASTIPADDRESS_TABLE

NotifyUnicastIpAddressChange

SetUnicastIpAddressEntry