Função GetBestInterfaceEx (iphlpapi.h)

Artigo
08/24/2023

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

Sintaxe

IPHLPAPI_DLL_LINKAGE DWORD GetBestInterfaceEx(
  [in]  sockaddr *pDestAddr,
  [out] PDWORD   pdwBestIfIndex
);

Parâmetros

[in] pDestAddr

O endereço IPv6 ou IPv4 de destino para o qual recuperar a interface com a melhor rota, na forma de uma estrutura sockaddr .

[out] pdwBestIfIndex

Um ponteiro para o índice da interface com a melhor rota para o endereço IPv6 ou IPv4 especificado por pDestAddr.

Valor retornado

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_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 os parâmetros pDestAddr ou pdwBestIfIndex apontarem para a memória que não pode ser acessada. Esse erro também poderá ser retornado se o parâmetro pdwBestIfIndex apontar para a memória que não pode ser gravada.
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 parâmetro pDestAddr ou nenhuma pilha IPv6 estiver no computador local e um endereço IPv6 tiver sido especificado no parâmetro pDestAddr .
Outros	Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetBestInterfaceEx difere da função GetBestInterface , pois pode ser usada com endereços IPv4 ou IPv6.

O membro Family da estrutura sockaddr apontada pelo parâmetro pDestAddr deve ser definido como um dos seguintes valores: AF_INET ou AF_INET6.

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

Requisitos


Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho \| aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho \| Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	iphlpapi.h
Biblioteca	Iphlpapi.lib
DLL	Iphlpapi.dll