ホーム › NetworkManagement.IpHelper › IP_INTERFACE_INFO

IP_INTERFACE_INFO

構造体

サイズx64: 264 バイト / x86: 264 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド	型	サイズ	x64	x86	説明
NumAdapters	INT	4	+0	+0	Adapter メンバーが指す配列に列挙されているアダプターの数です。
Adapter	IP_ADAPTER_INDEX_MAP	260	+4	+4	IP_ADAPTER_INDEX_MAP 構造体の配列です。各構造体は、アダプターのインデックスをそのアダプターの名前に対応付けます。アダプターのインデックスは、アダプターが無効化されてから再度有効化された場合など、さまざまな状況で変化する可能性があるため、永続的な値とみなすべきではありません。

公式ドキュメント

IP_INTERFACE_INFO 構造体は、ローカルシステム上で IPv4 が有効になっているネットワークインターフェイスアダプターの一覧を格納します。

解説(Remarks)

IP_INTERFACE_INFO 構造体は、IPv4 が有効になっているネットワークアダプターに固有のものです。IP_INTERFACE_INFO 構造体には、ローカルシステム上で IPv4 が有効になっているネットワークアダプターの数と、IPv4 が有効な各ネットワークアダプターの情報を格納した IP_ADAPTER_INDEX_MAP 構造体の配列が含まれます。IP_INTERFACE_INFO 構造体の NumAdapters メンバーが、IPv4 が有効なネットワークアダプターが 1 つも無いことを示している場合でも、IP_INTERFACE_INFO 構造体には少なくとも 1 つの IP_ADAPTER_INDEX_MAP 構造体が含まれます。IP_INTERFACE_INFO 構造体の NumAdapters メンバーが 0 の場合、IP_INTERFACE_INFO 構造体で返される単一の IP_ADAPTER_INDEX_MAP 構造体のメンバーの値は未定義です。

IP_INTERFACE_INFO 構造体を使用して、ループバックインターフェイスに関する情報を取得することはできません。

Windows Vista 以降では、IP_INTERFACE_INFO 構造体に含まれる IP_ADAPTER_INDEX_MAP 構造体の Name メンバーが、ネットワークインターフェイスの GUID を表す Unicode 文字列 ('{' 文字で始まる文字列) になる場合があります。

この構造体は Ipexport.h ヘッダーファイルで定義されており、このファイルは Iphlpapi.h ヘッダーファイルに自動的にインクルードされます。Ipexport.h ヘッダーファイルを直接使用しないでください。

例

次の例では、ローカルシステム上で IPv4 が有効になっているネットワークアダプターの一覧を取得し、最初のアダプターのさまざまなプロパティを出力します。

// Declare and initialize variables
PIP_INTERFACE_INFO pInfo;
pInfo = (IP_INTERFACE_INFO *) malloc( sizeof(IP_INTERFACE_INFO) );
ULONG ulOutBufLen = 0;
DWORD dwRetVal = 0;


// Make an initial call to GetInterfaceInfo to get
// the necessary size in the ulOutBufLen variable
if ( GetInterfaceInfo(pInfo, &ulOutBufLen) == ERROR_INSUFFICIENT_BUFFER) {
  free(pInfo);
  pInfo = (IP_INTERFACE_INFO *) malloc (ulOutBufLen);
}

// Make a second call to GetInterfaceInfo to get
// the actual data we need
if ((dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen)) == NO_ERROR ) {
  printf("\tAdapter Name: %ws\n", pInfo->Adapter[0].Name);
  printf("\tAdapter Index: %ld\n", pInfo->Adapter[0].Index);
  printf("\tNum Adapters: %ld\n", pInfo->NumAdapters);

  // free memory allocated
  free(pInfo);
  pInfo = NULL;
}  
else if (dwRetVal == ERROR_NO_DATA) {
  printf("There are no network adapters with IPv4 enabled on the local system\n");
}

else {
  printf("GetInterfaceInfo failed.\n");
  LPVOID lpMsgBuf;
            
  if (FormatMessage( 
    FORMAT_MESSAGE_ALLOCATE_BUFFER | 
    FORMAT_MESSAGE_FROM_SYSTEM | 
    FORMAT_MESSAGE_IGNORE_INSERTS,
    NULL,
    dwRetVal,
    MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
    (LPTSTR) &lpMsgBuf,
    0,
    NULL ))  {
    printf("\tError: %s", lpMsgBuf);
  }
  LocalFree( lpMsgBuf );
}

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

各言語での定義

#include <windows.h>

// IP_ADAPTER_INDEX_MAP  (x64 260 / x86 260 バイト)
typedef struct IP_ADAPTER_INDEX_MAP {
    DWORD Index;
    WCHAR Name[128];
} IP_ADAPTER_INDEX_MAP;

// IP_INTERFACE_INFO  (x64 264 / x86 264 バイト)
typedef struct IP_INTERFACE_INFO {
    INT NumAdapters;
    IP_ADAPTER_INDEX_MAP Adapter[1];
} IP_INTERFACE_INFO;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IP_ADAPTER_INDEX_MAP
{
    public uint Index;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)] public string Name;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct IP_INTERFACE_INFO
{
    public int NumAdapters;
    [MarshalAs(UnmanagedType.ByValArray, SizeConst = 1)] public IP_ADAPTER_INDEX_MAP[] Adapter;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IP_ADAPTER_INDEX_MAP
    Public Index As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=128)> Public Name As String
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure IP_INTERFACE_INFO
    Public NumAdapters As Integer
    <MarshalAs(UnmanagedType.ByValArray, SizeConst:=1)> Public Adapter() As IP_ADAPTER_INDEX_MAP
End Structure

import ctypes
from ctypes import wintypes

class IP_ADAPTER_INDEX_MAP(ctypes.Structure):
    _fields_ = [
        ("Index", wintypes.DWORD),
        ("Name", ctypes.c_wchar * 128),
    ]

class IP_INTERFACE_INFO(ctypes.Structure):
    _fields_ = [
        ("NumAdapters", ctypes.c_int),
        ("Adapter", IP_ADAPTER_INDEX_MAP * 1),
    ]

#[repr(C)]
pub struct IP_ADAPTER_INDEX_MAP {
    pub Index: u32,
    pub Name: [u16; 128],
}

#[repr(C)]
pub struct IP_INTERFACE_INFO {
    pub NumAdapters: i32,
    pub Adapter: [IP_ADAPTER_INDEX_MAP; 1],
}

import "golang.org/x/sys/windows"

type IP_ADAPTER_INDEX_MAP struct {
	Index uint32
	Name [128]uint16
}

type IP_INTERFACE_INFO struct {
	NumAdapters int32
	Adapter [1]IP_ADAPTER_INDEX_MAP
}

type
  IP_ADAPTER_INDEX_MAP = record
    Index: DWORD;
    Name: array[0..127] of WideChar;
  end;

  IP_INTERFACE_INFO = record
    NumAdapters: Integer;
    Adapter: array[0..0] of IP_ADAPTER_INDEX_MAP;
  end;

const IP_ADAPTER_INDEX_MAP = extern struct {
    Index: u32,
    Name: [128]u16,
};

const IP_INTERFACE_INFO = extern struct {
    NumAdapters: i32,
    Adapter: [1]IP_ADAPTER_INDEX_MAP,
};

type
  IP_ADAPTER_INDEX_MAP {.bycopy.} = object
    Index: uint32
    Name: array[128, uint16]

  IP_INTERFACE_INFO {.bycopy.} = object
    NumAdapters: int32
    Adapter: array[1, IP_ADAPTER_INDEX_MAP]

struct IP_ADAPTER_INDEX_MAP
{
    uint Index;
    wchar[128] Name;
}

struct IP_INTERFACE_INFO
{
    int NumAdapters;
    IP_ADAPTER_INDEX_MAP[1] Adapter;
}

HSP用定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; IP_INTERFACE_INFO サイズ: 264 バイト(x64)
dim st, 66    ; 4byte整数×66(構造体サイズ 264 / 4 切り上げ)
; NumAdapters : INT (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Adapter : IP_ADAPTER_INDEX_MAP (+4, 260byte)  varptr(st)+4 を基点に操作(260byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global IP_ADAPTER_INDEX_MAP
    #field int Index
    #field wchar Name 128
#endstruct

#defstruct global IP_INTERFACE_INFO
    #field int NumAdapters
    #field IP_ADAPTER_INDEX_MAP Adapter 1
#endstruct

stdim st, IP_INTERFACE_INFO        ; NSTRUCT 変数を確保
st->NumAdapters = 100
mes "NumAdapters=" + st->NumAdapters