Win32 API 日本語リファレンス
ホームNetworkManagement.IpHelper › GetAdaptersInfo

GetAdaptersInfo

関数
ローカルマシンのネットワークアダプター情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// IPHLPAPI.dll
#include <windows.h>

DWORD GetAdaptersInfo(
    IP_ADAPTER_INFO* AdapterInfo,   // optional
    DWORD* SizePointer
);

パラメーター

名前方向説明
AdapterInfoIP_ADAPTER_INFO*outoptionalIP_ADAPTER_INFO 構造体の連結リストを受け取るバッファーへのポインター。
SizePointerDWORD*inoutpAdapterInfo パラメーターが指すバッファーのサイズを指定する ULONG 変数へのポインター。このサイズがアダプター情報を保持するのに不十分な場合、GetAdaptersInfo はこの変数に必要なサイズを格納し、エラーコード ERROR_BUFFER_OVERFLOW を返します。

戻り値の型: DWORD

公式ドキュメント

GetAdaptersInfo 関数は、ローカルコンピューターのアダプター情報を取得します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS(NO_ERROR と同じ値として定義されています)です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値 説明
ERROR_BUFFER_OVERFLOW
アダプター情報を受け取るバッファーが小さすぎます。この値は、pOutBufLen パラメーターで示されるバッファーサイズがアダプター情報を保持するには小さすぎる場合、または pAdapterInfo パラメーターが NULL ポインターであった場合に返されます。このエラーコードが返されたとき、pOutBufLen パラメーターは必要なバッファーサイズを指します。
ERROR_INVALID_DATA
無効なアダプター情報が取得されました。
ERROR_INVALID_PARAMETER
パラメーターのいずれかが無効です。このエラーは、pOutBufLen パラメーターが NULL ポインターである場合、呼び出し元プロセスが pOutBufLen が指すメモリへの読み取り/書き込みアクセス権を持たない場合、または呼び出し元プロセスが pAdapterInfo パラメーターが指すメモリへの書き込みアクセス権を持たない場合に返されます。
ERROR_NO_DATA
ローカルコンピューターにアダプター情報が存在しません。
ERROR_NOT_SUPPORTED
GetAdaptersInfo 関数は、ローカルコンピューターで実行されているオペレーティングシステムでサポートされていません。
その他
関数が失敗した場合は、FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

GetAdaptersInfo 関数は、IPv4 アドレスの情報のみを取得できます。

Windows 10 より前のバージョンでは、この関数が返すリスト内でアダプターが現れる順序は、ネットワーク接続フォルダーから制御できます。詳細設定メニューから「詳細設定」メニュー項目を選択します。Windows 10 以降では、順序は規定されていません。

GetAdaptersInfo および GetInterfaceInfo 関数は、IPv4 ループバックインターフェイスに関する情報を返しません。ループバックインターフェイスの情報は、GetIpAddrTable 関数によって返されます。

Windows XP 以降の場合: GetAdaptersInfo が返すアダプターのリストには、単方向アダプターが含まれます。データの送受信の両方が可能なアダプターのリストを生成するには、GetUniDirectionalAdapterInfo を呼び出し、返されたアダプターを GetAdaptersInfo が返すリストから除外してください。

この例では、アダプター情報を取得し、各アダプターのさまざまなプロパティを出力します。

#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;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// IPHLPAPI.dll
#include <windows.h>

DWORD GetAdaptersInfo(
    IP_ADAPTER_INFO* AdapterInfo,   // optional
    DWORD* SizePointer
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetAdaptersInfo(
    IntPtr AdapterInfo,   // IP_ADAPTER_INFO* optional, out
    ref uint SizePointer   // DWORD* in/out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetAdaptersInfo(
    AdapterInfo As IntPtr,   ' IP_ADAPTER_INFO* optional, out
    ByRef SizePointer As UInteger   ' DWORD* in/out
) As UInteger
End Function
' AdapterInfo : IP_ADAPTER_INFO* optional, out
' SizePointer : DWORD* in/out
Declare PtrSafe Function GetAdaptersInfo Lib "iphlpapi" ( _
    ByVal AdapterInfo As LongPtr, _
    ByRef SizePointer As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetAdaptersInfo = ctypes.windll.iphlpapi.GetAdaptersInfo
GetAdaptersInfo.restype = wintypes.DWORD
GetAdaptersInfo.argtypes = [
    ctypes.c_void_p,  # AdapterInfo : IP_ADAPTER_INFO* optional, out
    ctypes.POINTER(wintypes.DWORD),  # SizePointer : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetAdaptersInfo = Fiddle::Function.new(
  lib['GetAdaptersInfo'],
  [
    Fiddle::TYPE_VOIDP,  # AdapterInfo : IP_ADAPTER_INFO* optional, out
    Fiddle::TYPE_VOIDP,  # SizePointer : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn GetAdaptersInfo(
        AdapterInfo: *mut IP_ADAPTER_INFO,  // IP_ADAPTER_INFO* optional, out
        SizePointer: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetAdaptersInfo(IntPtr AdapterInfo, ref uint SizePointer);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetAdaptersInfo' -Namespace Win32 -PassThru
# $api::GetAdaptersInfo(AdapterInfo, SizePointer)
#uselib "IPHLPAPI.dll"
#func global GetAdaptersInfo "GetAdaptersInfo" sptr, sptr
; GetAdaptersInfo varptr(AdapterInfo), varptr(SizePointer)   ; 戻り値は stat
; AdapterInfo : IP_ADAPTER_INFO* optional, out -> "sptr"
; SizePointer : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "IPHLPAPI.dll"
#cfunc global GetAdaptersInfo "GetAdaptersInfo" var, var
; res = GetAdaptersInfo(AdapterInfo, SizePointer)
; AdapterInfo : IP_ADAPTER_INFO* optional, out -> "var"
; SizePointer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD GetAdaptersInfo(IP_ADAPTER_INFO* AdapterInfo, DWORD* SizePointer)
#uselib "IPHLPAPI.dll"
#cfunc global GetAdaptersInfo "GetAdaptersInfo" var, var
; res = GetAdaptersInfo(AdapterInfo, SizePointer)
; AdapterInfo : IP_ADAPTER_INFO* optional, out -> "var"
; SizePointer : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetAdaptersInfo = iphlpapi.NewProc("GetAdaptersInfo")
)

// AdapterInfo (IP_ADAPTER_INFO* optional, out), SizePointer (DWORD* in/out)
r1, _, err := procGetAdaptersInfo.Call(
	uintptr(AdapterInfo),
	uintptr(SizePointer),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetAdaptersInfo(
  AdapterInfo: Pointer;   // IP_ADAPTER_INFO* optional, out
  SizePointer: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetAdaptersInfo';
result := DllCall("IPHLPAPI\GetAdaptersInfo"
    , "Ptr", AdapterInfo   ; IP_ADAPTER_INFO* optional, out
    , "Ptr", SizePointer   ; DWORD* in/out
    , "UInt")   ; return: DWORD
●GetAdaptersInfo(AdapterInfo, SizePointer) = DLL("IPHLPAPI.dll", "dword GetAdaptersInfo(void*, void*)")
# 呼び出し: GetAdaptersInfo(AdapterInfo, SizePointer)
# AdapterInfo : IP_ADAPTER_INFO* optional, out -> "void*"
# SizePointer : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "iphlpapi" fn GetAdaptersInfo(
    AdapterInfo: [*c]IP_ADAPTER_INFO, // IP_ADAPTER_INFO* optional, out
    SizePointer: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) u32;
proc GetAdaptersInfo(
    AdapterInfo: ptr IP_ADAPTER_INFO,  # IP_ADAPTER_INFO* optional, out
    SizePointer: ptr uint32  # DWORD* in/out
): uint32 {.importc: "GetAdaptersInfo", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetAdaptersInfo(
    IP_ADAPTER_INFO* AdapterInfo,   // IP_ADAPTER_INFO* optional, out
    uint* SizePointer   // DWORD* in/out
);
ccall((:GetAdaptersInfo, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{IP_ADAPTER_INFO}, Ptr{UInt32}),
      AdapterInfo, SizePointer)
# AdapterInfo : IP_ADAPTER_INFO* optional, out -> Ptr{IP_ADAPTER_INFO}
# SizePointer : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetAdaptersInfo(
    void* AdapterInfo,
    uint32_t* SizePointer);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetAdaptersInfo(AdapterInfo, SizePointer)
-- AdapterInfo : IP_ADAPTER_INFO* optional, out
-- SizePointer : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetAdaptersInfo = lib.func('__stdcall', 'GetAdaptersInfo', 'uint32_t', ['void *', 'uint32_t *']);
// GetAdaptersInfo(AdapterInfo, SizePointer)
// AdapterInfo : IP_ADAPTER_INFO* optional, out -> 'void *'
// SizePointer : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetAdaptersInfo: { parameters: ["pointer", "pointer"], result: "u32" },
});
// lib.symbols.GetAdaptersInfo(AdapterInfo, SizePointer)
// AdapterInfo : IP_ADAPTER_INFO* optional, out -> "pointer"
// SizePointer : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetAdaptersInfo(
    void* AdapterInfo,
    uint32_t* SizePointer);
C, "IPHLPAPI.dll");
// $ffi->GetAdaptersInfo(AdapterInfo, SizePointer);
// AdapterInfo : IP_ADAPTER_INFO* optional, out
// SizePointer : DWORD* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Iphlpapi extends StdCallLibrary {
    Iphlpapi INSTANCE = Native.load("iphlpapi", Iphlpapi.class);
    int GetAdaptersInfo(
        Pointer AdapterInfo,   // IP_ADAPTER_INFO* optional, out
        IntByReference SizePointer   // DWORD* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetAdaptersInfo = GetAdaptersInfo(
    AdapterInfo : IP_ADAPTER_INFO*,   # IP_ADAPTER_INFO* optional, out
    SizePointer : UInt32*   # DWORD* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef GetAdaptersInfoNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>);
typedef GetAdaptersInfoDart = int Function(Pointer<Void>, Pointer<Uint32>);
final GetAdaptersInfo = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetAdaptersInfoNative, GetAdaptersInfoDart>('GetAdaptersInfo');
// AdapterInfo : IP_ADAPTER_INFO* optional, out -> Pointer<Void>
// SizePointer : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetAdaptersInfo(
  AdapterInfo: Pointer;   // IP_ADAPTER_INFO* optional, out
  SizePointer: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetAdaptersInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetAdaptersInfo"
  c_GetAdaptersInfo :: Ptr () -> Ptr Word32 -> IO Word32
-- AdapterInfo : IP_ADAPTER_INFO* optional, out -> Ptr ()
-- SizePointer : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getadaptersinfo =
  foreign "GetAdaptersInfo"
    ((ptr void) @-> (ptr uint32_t) @-> returning uint32_t)
(* AdapterInfo : IP_ADAPTER_INFO* optional, out -> (ptr void) *)
(* SizePointer : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("GetAdaptersInfo" get-adapters-info :convention :stdcall) :uint32
  (adapter-info :pointer)   ; IP_ADAPTER_INFO* optional, out
  (size-pointer :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetAdaptersInfo = Win32::API::More->new('IPHLPAPI',
    'DWORD GetAdaptersInfo(LPVOID AdapterInfo, LPVOID SizePointer)');
# my $ret = $GetAdaptersInfo->Call($AdapterInfo, $SizePointer);
# AdapterInfo : IP_ADAPTER_INFO* optional, out -> LPVOID
# SizePointer : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型