ホーム › NetworkManagement.IpHelper › NhpAllocateAndGetInterfaceInfoFromStack

NhpAllocateAndGetInterfaceInfoFromStack

関数

TCP/IPスタックからインターフェイス名情報を割り当てて取得する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

DWORD NhpAllocateAndGetInterfaceInfoFromStack(
    IP_INTERFACE_NAME_INFO_W2KSP1** ppTable,
    DWORD* pdwCount,
    BOOL bOrder,
    HANDLE hHeap,
    DWORD dwFlags
);

パラメーター

名前	型	方向	説明
ppTable	IP_INTERFACE_NAME_INFO_W2KSP1**	out	ローカルシステム上の各アダプターに関する情報を格納する IP_INTERFACE_NAME_INFO 構造体の配列です。この配列には、システム上のアダプターごとに 1 つの要素が含まれます。
pdwCount	DWORD*	out	ppTable 配列内の要素数です。
bOrder	BOOL	in	TRUE の場合、ppTable 配列内の要素はインデックス値の昇順にソートされます。
hHeap	HANDLE	in	ppTable の割り当て元となるヒープを指定するハンドルです。このパラメーターには、GetProcessHeap 関数の呼び出しによって返されるプロセスヒープ、または HeapCreate 関数の呼び出しによって作成されたプライベートヒープを指定できます。
dwFlags	DWORD	in	ppTable 用のメモリを割り当てる際に HeapAlloc 関数へ渡すフラグのセットです。詳細については HeapAlloc 関数を参照してください。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

正常に完了した場合は ERROR_SUCCESS を返します。

解説(Remarks)

Microsoft Windows Software Development Kit (SDK) では、NhpAllocateAndGetInterfaceInfoFromStack 関数は Windows 2000 Service Pack 1 (SP1) 以降で定義されます。アプリケーションをコンパイルする際、ターゲットプラットフォームが Windows 2000 SP1 以降である場合 (NTDDI_VERSION >= NTDDI_WIN2KSP1、_WIN32_WINNT >= 0x0500、または WINVER >= 0x0500)、NhpAllocateAndGetInterfaceInfoFromStack が定義されます。

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

各言語での呼び出し定義

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

DWORD NhpAllocateAndGetInterfaceInfoFromStack(
    IP_INTERFACE_NAME_INFO_W2KSP1** ppTable,
    DWORD* pdwCount,
    BOOL bOrder,
    HANDLE hHeap,
    DWORD dwFlags
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint NhpAllocateAndGetInterfaceInfoFromStack(
    IntPtr ppTable,   // IP_INTERFACE_NAME_INFO_W2KSP1** out
    out uint pdwCount,   // DWORD* out
    bool bOrder,   // BOOL
    IntPtr hHeap,   // HANDLE
    uint dwFlags   // DWORD
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function NhpAllocateAndGetInterfaceInfoFromStack(
    ppTable As IntPtr,   ' IP_INTERFACE_NAME_INFO_W2KSP1** out
    <Out> ByRef pdwCount As UInteger,   ' DWORD* out
    bOrder As Boolean,   ' BOOL
    hHeap As IntPtr,   ' HANDLE
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function

' ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out
' pdwCount : DWORD* out
' bOrder : BOOL
' hHeap : HANDLE
' dwFlags : DWORD
Declare PtrSafe Function NhpAllocateAndGetInterfaceInfoFromStack Lib "iphlpapi" ( _
    ByVal ppTable As LongPtr, _
    ByRef pdwCount As Long, _
    ByVal bOrder As Long, _
    ByVal hHeap As LongPtr, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NhpAllocateAndGetInterfaceInfoFromStack = ctypes.windll.iphlpapi.NhpAllocateAndGetInterfaceInfoFromStack
NhpAllocateAndGetInterfaceInfoFromStack.restype = wintypes.DWORD
NhpAllocateAndGetInterfaceInfoFromStack.argtypes = [
    ctypes.c_void_p,  # ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out
    ctypes.POINTER(wintypes.DWORD),  # pdwCount : DWORD* out
    wintypes.BOOL,  # bOrder : BOOL
    wintypes.HANDLE,  # hHeap : HANDLE
    wintypes.DWORD,  # dwFlags : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
NhpAllocateAndGetInterfaceInfoFromStack = Fiddle::Function.new(
  lib['NhpAllocateAndGetInterfaceInfoFromStack'],
  [
    Fiddle::TYPE_VOIDP,  # ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out
    Fiddle::TYPE_VOIDP,  # pdwCount : DWORD* out
    Fiddle::TYPE_INT,  # bOrder : BOOL
    Fiddle::TYPE_VOIDP,  # hHeap : HANDLE
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn NhpAllocateAndGetInterfaceInfoFromStack(
        ppTable: *mut *mut IP_INTERFACE_NAME_INFO_W2KSP1,  // IP_INTERFACE_NAME_INFO_W2KSP1** out
        pdwCount: *mut u32,  // DWORD* out
        bOrder: i32,  // BOOL
        hHeap: *mut core::ffi::c_void,  // HANDLE
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint NhpAllocateAndGetInterfaceInfoFromStack(IntPtr ppTable, out uint pdwCount, bool bOrder, IntPtr hHeap, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_NhpAllocateAndGetInterfaceInfoFromStack' -Namespace Win32 -PassThru
# $api::NhpAllocateAndGetInterfaceInfoFromStack(ppTable, pdwCount, bOrder, hHeap, dwFlags)

#uselib "IPHLPAPI.dll"
#func global NhpAllocateAndGetInterfaceInfoFromStack "NhpAllocateAndGetInterfaceInfoFromStack" sptr, sptr, sptr, sptr, sptr
; NhpAllocateAndGetInterfaceInfoFromStack varptr(ppTable), varptr(pdwCount), bOrder, hHeap, dwFlags   ; 戻り値は stat
; ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out -> "sptr"
; pdwCount : DWORD* out -> "sptr"
; bOrder : BOOL -> "sptr"
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global NhpAllocateAndGetInterfaceInfoFromStack "NhpAllocateAndGetInterfaceInfoFromStack" var, var, int, sptr, int
; res = NhpAllocateAndGetInterfaceInfoFromStack(ppTable, pdwCount, bOrder, hHeap, dwFlags)
; ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out -> "var"
; pdwCount : DWORD* out -> "var"
; bOrder : BOOL -> "int"
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global NhpAllocateAndGetInterfaceInfoFromStack "NhpAllocateAndGetInterfaceInfoFromStack" sptr, sptr, int, sptr, int
; res = NhpAllocateAndGetInterfaceInfoFromStack(varptr(ppTable), varptr(pdwCount), bOrder, hHeap, dwFlags)
; ppTable : IP_INTERFACE_NAME_INFO_W2KSP1** out -> "sptr"
; pdwCount : DWORD* out -> "sptr"
; bOrder : BOOL -> "int"
; hHeap : HANDLE -> "sptr"
; dwFlags : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。