Share via


Função GetAdaptersInfo (iphlpapi.h)

A função GetAdaptersInfo recupera informações do adaptador para o computador local.

No Windows XP e posterior: Use a função GetAdaptersAddresses em vez de GetAdaptersInfo.

Sintaxe

IPHLPAPI_DLL_LINKAGE ULONG GetAdaptersInfo(
  [out]     PIP_ADAPTER_INFO AdapterInfo,
  [in, out] PULONG           SizePointer
);

Parâmetros

[out] AdapterInfo

Um ponteiro para um buffer que recebe uma lista vinculada de estruturas de IP_ADAPTER_INFO .

[in, out] SizePointer

Um ponteiro para uma variável ULONG que especifica o tamanho do buffer apontado pelo parâmetro pAdapterInfo . Se esse tamanho for insuficiente para manter as informações do adaptador, GetAdaptersInfo preencherá essa variável com o tamanho necessário e retornará um código de erro de ERROR_BUFFER_OVERFLOW.

Valor retornado

Se a função for bem-sucedida, o valor retornado será ERROR_SUCCESS (definido com o mesmo valor que NO_ERROR).

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

Código de retorno Descrição
ERROR_BUFFER_OVERFLOW
O buffer para receber as informações do adaptador é muito pequeno. Esse valor será retornado se o tamanho do buffer indicado pelo parâmetro pOutBufLen for muito pequeno para manter as informações do adaptador ou o parâmetro pAdapterInfo for um ponteiro NULL . Quando esse código de erro é retornado, o parâmetro pOutBufLen aponta para o tamanho do buffer necessário.
ERROR_INVALID_DATA
Informações inválidas do adaptador foram recuperadas.
ERROR_INVALID_PARAMETER
Um dos parâmetros é inválido. Esse erro será retornado se o parâmetro pOutBufLen for um ponteiro NULL ou se o processo de chamada não tiver acesso de leitura/gravação à memória apontada por pOutBufLen ou o processo de chamada não tiver acesso de gravação à memória apontada pelo parâmetro pAdapterInfo .
ERROR_NO_DATA
Não existe nenhuma informação do adaptador para o computador local.
ERROR_NOT_SUPPORTED
A função GetAdaptersInfo não tem suporte do sistema operacional em execução no computador local.
Outros
Se a função falhar, use FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado.

Comentários

A função GetAdaptersInfo pode recuperar informações somente para endereços IPv4.

Em versões anteriores ao Windows 10, a ordem na qual os adaptadores aparecem na lista retornada por essa função pode ser controlada na pasta Conexões de Rede: selecione o item de menu Configurações Avançadas no menu Avançado. A partir do Windows 10, o pedido não é especificado.

As funções GetAdaptersInfo e GetInterfaceInfo não retornam informações sobre a interface de loopback IPv4. As informações sobre a interface de loopback são retornadas pela função GetIpAddrTable .

No Windows XP e posterior: A lista de adaptadores retornados por GetAdaptersInfo inclui adaptadores unidirecionais. Para gerar uma lista de adaptadores que podem enviar e receber dados, chame GetUniDirectionalAdapterInfo e exclua os adaptadores retornados da lista retornada por GetAdaptersInfo.

Exemplos

Este exemplo recupera as informações do adaptador e imprime várias propriedades de cada adaptador.

#include <winsock2.h>
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>
#pragma comment(lib, "IPHLPAPI.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x))
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

/* Note: could also use malloc() and free() */

int __cdecl main()
{

    /* Declare and initialize variables */

// It is possible for an adapter to have multiple
// IPv4 addresses, gateways, and secondary WINS servers
// assigned to the adapter. 
//
// Note that this sample code only prints out the 
// first entry for the IP address/mask, and gateway, and
// the primary and secondary WINS server for each adapter. 

    PIP_ADAPTER_INFO pAdapterInfo;
    PIP_ADAPTER_INFO pAdapter = NULL;
    DWORD dwRetVal = 0;
    UINT i;

/* variables used to print DHCP time info */
    struct tm newtime;
    char buffer[32];
    errno_t error;

    ULONG ulOutBufLen = sizeof (IP_ADAPTER_INFO);
    pAdapterInfo = (IP_ADAPTER_INFO *) MALLOC(sizeof (IP_ADAPTER_INFO));
    if (pAdapterInfo == NULL) {
        printf("Error allocating memory needed to call GetAdaptersinfo\n");
        return 1;
    }
// Make an initial call to GetAdaptersInfo to get
// the necessary size into the ulOutBufLen variable
    if (GetAdaptersInfo(pAdapterInfo, &ulOutBufLen) == ERROR_BUFFER_OVERFLOW) {
        FREE(pAdapterInfo);
        pAdapterInfo = (IP_ADAPTER_INFO *) MALLOC(ulOutBufLen);
        if (pAdapterInfo == NULL) {
            printf("Error allocating memory needed to call GetAdaptersinfo\n");
            return 1;
        }
    }

    if ((dwRetVal = GetAdaptersInfo(pAdapterInfo, &ulOutBufLen)) == NO_ERROR) {
        pAdapter = pAdapterInfo;
        while (pAdapter) {
            printf("\tComboIndex: \t%d\n", pAdapter->ComboIndex);
            printf("\tAdapter Name: \t%s\n", pAdapter->AdapterName);
            printf("\tAdapter Desc: \t%s\n", pAdapter->Description);
            printf("\tAdapter Addr: \t");
            for (i = 0; i < pAdapter->AddressLength; i++) {
                if (i == (pAdapter->AddressLength - 1))
                    printf("%.2X\n", (int) pAdapter->Address[i]);
                else
                    printf("%.2X-", (int) pAdapter->Address[i]);
            }
            printf("\tIndex: \t%d\n", pAdapter->Index);
            printf("\tType: \t");
            switch (pAdapter->Type) {
            case MIB_IF_TYPE_OTHER:
                printf("Other\n");
                break;
            case MIB_IF_TYPE_ETHERNET:
                printf("Ethernet\n");
                break;
            case MIB_IF_TYPE_TOKENRING:
                printf("Token Ring\n");
                break;
            case MIB_IF_TYPE_FDDI:
                printf("FDDI\n");
                break;
            case MIB_IF_TYPE_PPP:
                printf("PPP\n");
                break;
            case MIB_IF_TYPE_LOOPBACK:
                printf("Loopback\n");
                break;
            case MIB_IF_TYPE_SLIP:
                printf("Slip\n");
                break;
            default:
                printf("Unknown type %ld\n", pAdapter->Type);
                break;
            }

            printf("\tIP Address: \t%s\n",
                   pAdapter->IpAddressList.IpAddress.String);
            printf("\tIP Mask: \t%s\n", pAdapter->IpAddressList.IpMask.String);

            printf("\tGateway: \t%s\n", pAdapter->GatewayList.IpAddress.String);
            printf("\t***\n");

            if (pAdapter->DhcpEnabled) {
                printf("\tDHCP Enabled: Yes\n");
                printf("\t  DHCP Server: \t%s\n",
                       pAdapter->DhcpServer.IpAddress.String);

                printf("\t  Lease Obtained: ");
                /* Display local time */
                error = _localtime32_s(&newtime, (__time32_t*) &pAdapter->LeaseObtained);
                if (error)
                    printf("Invalid Argument to _localtime32_s\n");
                else {
                    // Convert to an ASCII representation 
                    error = asctime_s(buffer, 32, &newtime);
                    if (error)
                        printf("Invalid Argument to asctime_s\n");
                    else
                        /* asctime_s returns the string terminated by \n\0 */
                        printf("%s", buffer);
                }

                printf("\t  Lease Expires:  ");
                error = _localtime32_s(&newtime, (__time32_t*) &pAdapter->LeaseExpires);
                if (error)
                    printf("Invalid Argument to _localtime32_s\n");
                else {
                    // Convert to an ASCII representation 
                    error = asctime_s(buffer, 32, &newtime);
                    if (error)
                        printf("Invalid Argument to asctime_s\n");
                    else
                        /* asctime_s returns the string terminated by \n\0 */
                        printf("%s", buffer);
                }
            } else
                printf("\tDHCP Enabled: No\n");

            if (pAdapter->HaveWins) {
                printf("\tHave Wins: Yes\n");
                printf("\t  Primary Wins Server:    %s\n",
                       pAdapter->PrimaryWinsServer.IpAddress.String);
                printf("\t  Secondary Wins Server:  %s\n",
                       pAdapter->SecondaryWinsServer.IpAddress.String);
            } else
                printf("\tHave Wins: No\n");
            pAdapter = pAdapter->Next;
            printf("\n");
        }
    } else {
        printf("GetAdaptersInfo failed with error: %d\n", dwRetVal);

    }
    if (pAdapterInfo)
        FREE(pAdapterInfo);

    return 0;
}

Requisitos

   
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho iphlpapi.h
Biblioteca Iphlpapi.lib
DLL Iphlpapi.dll

Confira também

Getadaptersaddresses

GetInterfaceInfo

GetIpAddrTable

GetNumberOfInterfaces

GetUniDirectionalAdapterInfo

Referência de função auxiliar de IP

Página Inicial do Auxiliar de IP

IP_ADAPTER_INFO