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

GetIpNetEntry2

関数
指定した近隣(IP-物理アドレス)エントリの情報を取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetIpNetEntry2(
    MIB_IPNET_ROW2* Row
);

パラメーター

名前型方向説明
RowMIB_IPNET_ROW2*inout近隣 IP アドレスエントリを表す MIB_IPNET_ROW2 構造体エントリへのポインター。正常に復帰すると、この構造体には近隣 IP アドレスのプロパティが設定されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の近隣 IP アドレスエントリの情報を取得します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

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

戻り値 説明
ERROR_FILE_NOT_FOUND
 指定されたファイルが見つかりません。このエラーは、Row パラメーターが指す MIB_IPNET_ROW2 の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスの LUID またはインターフェイスインデックスが、ローカルマシン上の値でなかった場合に返されます。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_IPNET_ROW2 の Address メンバーが有効な近隣 IPv4 または IPv6 アドレスに設定されていなかった場合、または Row パラメーターが指す MIB_IPNET_ROW2 の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていなかった場合に返されます。
ERROR_NOT_FOUND
 要素が見つかりません。このエラーは、Row パラメーターが指す MIB_IPNET_ROW2 構造体の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが、MIB_IPNET_ROW2 構造体の Address メンバーで指定された近隣 IP アドレスおよびアドレスファミリと一致しない場合に返されます。
ERROR_NOT_SUPPORTED
 要求がサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_IPNET_ROW2 構造体の Address メンバーに IPv4 アドレスが指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず、MIB_IPNET_ROW2 構造体の Address メンバーに IPv6 アドレスが指定された場合にも返されます。
その他

FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

GetIpNetEntry2 関数は Windows Vista 以降で定義されています。

GetIpNetEntry2 関数は、MIB_IPNET_ROW2 構造体エントリを取得するために使用します。

入力時には、Row パラメーターが指す MIB_IPNET_ROW2 構造体の Address メンバーを、有効な近隣 IPv4 または IPv6 アドレスおよびファミリで初期化しておく必要があります。さらに、Row パラメーターが指す MIB_IPNET_ROW2 構造体の次のメンバーのうち、少なくとも 1 つを初期化する必要があります。 InterfaceLuid または InterfaceIndex。

これらのフィールドは上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値が 0 に設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが決定されます。

呼び出しが成功した出力時には、GetIpNetEntry2 は近隣 IP アドレスのその他のプロパティを取得し、Row パラメーターが指す MIB_IPNET_ROW2 構造体に値を設定します。

ローカルコンピューター上の近隣 IP アドレスエントリを列挙するには、GetIpNetTable2 関数を呼び出すことができます。

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

各言語での呼び出し定義

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

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

GetIpNetEntry2 = ctypes.windll.iphlpapi.GetIpNetEntry2
GetIpNetEntry2.restype = wintypes.DWORD
GetIpNetEntry2.argtypes = [
    ctypes.c_void_p,  # Row : MIB_IPNET_ROW2* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIpNetEntry2 = iphlpapi.NewProc("GetIpNetEntry2")
)

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

extern "iphlpapi" fn GetIpNetEntry2(
    Row: [*c]MIB_IPNET_ROW2 // MIB_IPNET_ROW2* in/out
) callconv(std.os.windows.WINAPI) u32;
proc GetIpNetEntry2(
    Row: ptr MIB_IPNET_ROW2  # MIB_IPNET_ROW2* in/out
): uint32 {.importc: "GetIpNetEntry2", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIpNetEntry2(
    MIB_IPNET_ROW2* Row   // MIB_IPNET_ROW2* in/out
);
ccall((:GetIpNetEntry2, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IPNET_ROW2},),
      Row)
# Row : MIB_IPNET_ROW2* in/out -> Ptr{MIB_IPNET_ROW2}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIpNetEntry2(
    void* Row);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIpNetEntry2(Row)
-- Row : MIB_IPNET_ROW2* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIpNetEntry2 = lib.func('__stdcall', 'GetIpNetEntry2', 'uint32_t', ['void *']);
// GetIpNetEntry2(Row)
// Row : MIB_IPNET_ROW2* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIpNetEntry2: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetIpNetEntry2(Row)
// Row : MIB_IPNET_ROW2* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIpNetEntry2(
    void* Row);
C, "IPHLPAPI.dll");
// $ffi->GetIpNetEntry2(Row);
// Row : MIB_IPNET_ROW2* 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 GetIpNetEntry2(
        Pointer Row   // MIB_IPNET_ROW2* in/out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIpNetEntry2 = GetIpNetEntry2(
    Row : MIB_IPNET_ROW2*   # MIB_IPNET_ROW2* 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 GetIpNetEntry2Native = Uint32 Function(Pointer<Void>);
typedef GetIpNetEntry2Dart = int Function(Pointer<Void>);
final GetIpNetEntry2 = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<GetIpNetEntry2Native, GetIpNetEntry2Dart>('GetIpNetEntry2');
// Row : MIB_IPNET_ROW2* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetIpNetEntry2(
  Row: Pointer   // MIB_IPNET_ROW2* in/out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'GetIpNetEntry2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetIpNetEntry2"
  c_GetIpNetEntry2 :: Ptr () -> IO Word32
-- Row : MIB_IPNET_ROW2* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

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