Função GetBestInterface (iphlpapi.h)

A função GetBestInterface recupera o índice da interface que tem a melhor rota para o endereço IPv4 especificado.

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD GetBestInterface(
  [in]  IPAddr dwDestAddr,
  [out] PDWORD pdwBestIfIndex
);

Parameters

[in] dwDestAddr

O endereço IPv4 de destino para o qual recuperar a interface que tem a melhor rota, na forma de uma estrutura IPAddr .

[out] pdwBestIfIndex

Um ponteiro para uma variável DWORD que recebe o índice da interface que tem a melhor rota para o endereço IPv4 especificado por dwDestAddr.

Valor de devolução

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Código de retorno Description
ERROR_CAN_NOT_COMPLETE
 Não foi possível concluir a operação.
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 pdwBestIfIndex ou se o pdwBestIfIndex apontar para a memória que não pode ser gravada.
ERROR_NOT_SUPPORTED
 Não há suporte para a solicitação. Esse erro será retornado se nenhuma pilha IPv4 estiver no computador local.
Outras
 Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Observações

A função GetBestInterface funciona apenas com endereços IPv4. Para uso com endereços IPv6, o GetBestInterfaceEx deve ser usado.

Para obter informações sobre o tipo de dados IPAddr, consulte Windows tipos de dados. Para converter um endereço IP entre a notação decimal pontilhada e o formato IPAddr , use as funções inet_addr e inet_ntoa .

Em Windows Vista e posterior, o parâmetro pdwBestIfIndex é tratado internamente pelo Auxiliar de IP como um ponteiro para um tipo de dados NET_IFINDEX.

Requirements

Requirement Valor
Cliente mínimo suportado Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo compatível Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino Windows
Header iphlpapi.h
Library Iphlpapi.lib
de DLL Iphlpapi.dll

Consulte também

GetBestInterfaceEx

GetBestRoute

Referência de função auxiliar de IP

Página Inicial do Auxiliar de IP

IPAddr

MIB_BEST_IF

Tipos de Dados Windows

  • Última atualização em