Função DeleteUnicastIpAddressEntry

2025-03-13

A função DeleteUnicastIpAddressEntry exclui uma entrada de endereço IP unicast existente em um computador local.

Sintaxe

NETIOAPI_API DeleteUnicastIpAddressEntry(
  _In_ const MIB_UNICASTIPADDRESS_ROW *Row
);

Parâmetros

linha [in]
Um ponteiro para uma entrada de estrutura MIB_UNICASTIPADDRESS_ROW para uma entrada de endereço IP unicast existente a ser excluída do computador local.

Valor de retorno

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

Se a função falhar, DeleteUnicastIpAddressEntry 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 de Endereço membro da estrutura MIB_UNICASTIPADDRESS_ROW à qual o parâmetro Row aponta não foi definido como um endereço IPv4 ou IPv6 unicast válido, ou ambos InterfaceLuid e interfaceIndex membros 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 InterfaceLuid ou interfaceIndex membro da estrutura MIB_UNICASTIPADDRESS_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 DeleteUnicastIpAddressEntry é usada para excluir uma entrada de estrutura MIB_UNICASTIPADDRESS_ROW existente no computador local.

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

endereço
Defina como um endereço IPv4 ou IPv6 unicast 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.

Se a função for bem-sucedida, o endereço IP existente que o parâmetro Row representa será excluído.

O driver pode chamar a função GetUnicastIpAddressTable para enumerar as entradas de endereço IP unicast em um computador local. O driver pode chamar a função GetUnicastIpAddressEntry para recuperar uma entrada de endereço IP unicast específica.

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