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

GetIfStackTable

関数
インターフェイス間の階層(スタック)関係テーブルを取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

WIN32_ERROR GetIfStackTable(
    MIB_IFSTACK_TABLE** Table
);

パラメーター

名前型方向説明
TableMIB_IFSTACK_TABLE**outインターフェイススタックの行エントリのテーブルを受け取るバッファへのポインター。MIB_IFSTACK_TABLE 構造体として格納されます。

戻り値の型: WIN32_ERROR

公式ドキュメント

インターフェイススタック上のネットワークインターフェイス間の関係を示す、ネットワークインターフェイススタックの行エントリのテーブルを取得します。

戻り値

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

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

戻り値 説明
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。このエラーは、Table パラメーターに NULL ポインターが渡された場合に返されます。
ERROR_NOT_ENOUGH_MEMORY
 操作を完了するための十分なメモリリソースがありません。
ERROR_NOT_FOUND
 インターフェイススタックのエントリが見つかりませんでした。
その他
 返されたエラーに対応するメッセージ文字列を取得するには、FormatMessage 関数を使用してください。

解説(Remarks)

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

GetIfStackTable 関数は、ローカルシステム上のインターフェイススタックにある物理および論理ネットワークインターフェイスを列挙し、その情報を MIB_IFSTACK_TABLE 構造体として返します。

インターフェイススタックのエントリは、Table パラメーターが指すバッファ内に MIB_IFSTACK_TABLE 構造体として返されます。MIB_IFSTACK_TABLE 構造体には、インターフェイススタックのエントリ数と、各インターフェイススタックエントリに対応する MIB_IFSTACK_ROW 構造体の配列が含まれます。

インターフェイススタック内のインターフェイス間の関係は、MIB_IFSTACK_ROW 構造体の HigherLayerInterfaceIndex メンバーにインデックスを持つインターフェイスが、MIB_IFSTACK_ROW 構造体の LowerLayerInterfaceIndex メンバーにインデックスを持つインターフェイスの直上に位置する、というものです。

MIB_IFSTACK_TABLE 構造体と、その構造体内の MIB_IFSTACK_ROW エントリのメモリは、GetIfStackTable 関数によって割り当てられます。これらの返された構造体が不要になったら、FreeMibTable を呼び出してメモリを解放してください。

Table パラメーターが指す、返された MIB_IFSTACK_TABLE 構造体では、MIB_IFSTACK_TABLE 構造体の NumEntries メンバーと、Table メンバー内の最初の MIB_IFSTACK_ROW 配列エントリとの間に、アラインメントのためのパディングが含まれる場合がある点に注意してください。MIB_IFSTACK_ROW 配列エントリ間にもアラインメントのためのパディングが存在する場合があります。MIB_IFSTACK_ROW 配列エントリにアクセスする際は、常にパディングが存在する可能性を想定してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 GetIfStackTable(
    MIB_IFSTACK_TABLE** Table
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetIfStackTable(
    IntPtr Table   // MIB_IFSTACK_TABLE** out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetIfStackTable(
    Table As IntPtr   ' MIB_IFSTACK_TABLE** out
) As UInteger
End Function
' Table : MIB_IFSTACK_TABLE** out
Declare PtrSafe Function GetIfStackTable Lib "iphlpapi" ( _
    ByVal Table As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetIfStackTable = ctypes.windll.iphlpapi.GetIfStackTable
GetIfStackTable.restype = wintypes.DWORD
GetIfStackTable.argtypes = [
    ctypes.c_void_p,  # Table : MIB_IFSTACK_TABLE** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procGetIfStackTable = iphlpapi.NewProc("GetIfStackTable")
)

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

extern "iphlpapi" fn GetIfStackTable(
    Table: [*c][*c]MIB_IFSTACK_TABLE // MIB_IFSTACK_TABLE** out
) callconv(std.os.windows.WINAPI) u32;
proc GetIfStackTable(
    Table: ptr MIB_IFSTACK_TABLE  # MIB_IFSTACK_TABLE** out
): uint32 {.importc: "GetIfStackTable", stdcall, dynlib: "IPHLPAPI.dll".}
pragma(lib, "iphlpapi");
extern(Windows)
uint GetIfStackTable(
    MIB_IFSTACK_TABLE** Table   // MIB_IFSTACK_TABLE** out
);
ccall((:GetIfStackTable, "IPHLPAPI.dll"), stdcall, UInt32,
      (Ptr{MIB_IFSTACK_TABLE},),
      Table)
# Table : MIB_IFSTACK_TABLE** out -> Ptr{MIB_IFSTACK_TABLE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t GetIfStackTable(
    void* Table);
]]
local iphlpapi = ffi.load("iphlpapi")
-- iphlpapi.GetIfStackTable(Table)
-- Table : MIB_IFSTACK_TABLE** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('IPHLPAPI.dll');
const GetIfStackTable = lib.func('__stdcall', 'GetIfStackTable', 'uint32_t', ['void *']);
// GetIfStackTable(Table)
// Table : MIB_IFSTACK_TABLE** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("IPHLPAPI.dll", {
  GetIfStackTable: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.GetIfStackTable(Table)
// Table : MIB_IFSTACK_TABLE** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t GetIfStackTable(
    void* Table);
C, "IPHLPAPI.dll");
// $ffi->GetIfStackTable(Table);
// Table : MIB_IFSTACK_TABLE** 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 GetIfStackTable(
        Pointer Table   // MIB_IFSTACK_TABLE** out
    );
}
@[Link("iphlpapi")]
lib LibIPHLPAPI
  fun GetIfStackTable = GetIfStackTable(
    Table : MIB_IFSTACK_TABLE**   # MIB_IFSTACK_TABLE** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

let getifstacktable =
  foreign "GetIfStackTable"
    ((ptr void) @-> returning uint32_t)
(* Table : MIB_IFSTACK_TABLE** 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 ("GetIfStackTable" get-if-stack-table :convention :stdcall) :uint32
  (table :pointer))   ; MIB_IFSTACK_TABLE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetIfStackTable = Win32::API::More->new('IPHLPAPI',
    'DWORD GetIfStackTable(LPVOID Table)');
# my $ret = $GetIfStackTable->Call($Table);
# Table : MIB_IFSTACK_TABLE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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