Função SetIpNetEntry2 (netioapi.h)

Artigo
08/25/2023

A função SetIpNetEntry2 define o endereço físico de uma entrada de endereço IP vizinho existente no computador local.

Sintaxe

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API SetIpNetEntry2(
  [in, out] PMIB_IPNET_ROW2 Row
);

Parâmetros

[in, out] Row

Um ponteiro para uma entrada de estrutura MIB_IPNET_ROW2 para uma entrada de endereço IP vizinho.

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_ACCESS_DENIED	Acesso negado. Esse erro é retornado sob várias condições que incluem o seguinte: o usuário não tem os privilégios administrativos necessários no computador local ou o aplicativo não está em execução em um shell aprimorado como administrador interno (administrador RunAs).
ERROR_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 do MIB_IPNET_ROW2 apontado pelo parâmetro Row não tiver sido definido como um endereço IPv4 ou IPv6 de unicast, anycast ou multicast válido, os membros PhysicalAddress e PhysicalAddressLength do MIB_IPNET_ROW2 apontados pelo parâmetro Row não foram definidos como um endereço físico válido, ou os membros InterfaceLuid ou InterfaceIndex do MIB_IPNET_ROW2 apontados pelo parâmetro Row não foram especificados. Esse erro também será retornado se um endereço de loopback tiver sido passado no membro Address .
ERROR_NOT_FOUND	Não foi possível encontrar a interface especificada. Esse erro será retornado se o adaptador de rede especificado pelo membro InterfaceLuid ou InterfaceIndex do MIB_IPNET_ROW2 apontado pelo parâmetro Row não puder ser encontrado.
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 tiver sido especificado no membro Address do MIB_IPNET_ROW2 apontado pelo parâmetro Row ou se nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 tiver sido especificado no membro Address .
Outros	Use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

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

A função SetIpNetEntry2 é usada para definir o endereço físico para uma entrada de endereço IP vizinho existente em um computador local.

O membro Address na estrutura de MIB_IPNET_ROW2 apontada pelo parâmetro Row deve ser inicializado para um endereço IPv4 ou IPv6 de IPv4 ou IPv6 válido. Os membros PhysicalAddress e PhysicalAddressLength na estrutura MIB_IPNET_ROW2 apontada pelo parâmetro Row devem ser inicializados para um endereço físico válido. Além disso, pelo menos um dos seguintes membros na estrutura MIB_IPNET_ROW2 apontado para o parâmetro Row deve ser inicializado para a interface: 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 na qual adicionar o endereço IP unicast. Se nenhum valor tiver sido definido para o membro InterfaceLuid (os valores desse membro foram definidos como zero), o membro InterfaceIndex será usado em seguida para determinar a interface.

A função SetIpNetEntry2 falhará se o endereço IP passado no membro Address do MIB_IPNET_ROW2 apontado pelo parâmetro Row não for um endereço IP vizinho existente na interface especificada.

A função SetIpNetEntry2 só pode ser chamada por um usuário conectado como membro do grupo Administradores. Se SetIpNetEntry2 for chamado por um usuário que não seja membro do grupo Administradores, a chamada de função falhará e ERROR_ACCESS_DENIED será retornado.

A função SetIpNetEntry2 também pode falhar devido ao UAC (controle de conta de usuário) no Windows Vista e posterior. Se um aplicativo que contém essa função for executado por um usuário conectado como um membro do grupo Administradores diferente do Administrador interno, essa chamada falhará, a menos que o aplicativo tenha sido marcado no arquivo de manifesto com um requestedExecutionLevel definido como requireAdministrator. Se o aplicativo não tiver esse arquivo de manifesto, um usuário conectado como membro do grupo Administradores diferente do Administrador interno deverá executar o aplicativo em um shell aprimorado como administrador interno (administrador RunAs) para que essa função tenha êxito.

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