ホーム › NetworkManagement.IpHelper › GetNumberOfInterfaces

GetNumberOfInterfaces

関数

システム上のネットワークインターフェイス数を取得する。

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

シグネチャ

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

DWORD GetNumberOfInterfaces(
    DWORD* pdwNumIf
);

パラメーター

名前	型	方向	説明
pdwNumIf	DWORD*	out	ローカルコンピューター上のインターフェイスの数を受け取る DWORD 変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

GetNumberOfInterfaces 関数は、ローカルコンピューター上のインターフェイスの数を取得します。

戻り値

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

関数が失敗した場合は、 FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

GetNumberOfInterfaces 関数は、ループバックインターフェイスを含む、ローカルコンピューター上のインターフェイスの数を返します。この数は、 GetAdaptersInfo 関数および GetInterfaceInfo 関数が返すアダプターの数より 1 つ多くなります。これは、これらの関数がループバックインターフェイスに関する情報を返さないためです。

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

各言語での呼び出し定義

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

DWORD GetNumberOfInterfaces(
    DWORD* pdwNumIf
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetNumberOfInterfaces(
    out uint pdwNumIf   // DWORD* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetNumberOfInterfaces(
    <Out> ByRef pdwNumIf As UInteger   ' DWORD* out
) As UInteger
End Function

' pdwNumIf : DWORD* out
Declare PtrSafe Function GetNumberOfInterfaces Lib "iphlpapi" ( _
    ByRef pdwNumIf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNumberOfInterfaces = ctypes.windll.iphlpapi.GetNumberOfInterfaces
GetNumberOfInterfaces.restype = wintypes.DWORD
GetNumberOfInterfaces.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pdwNumIf : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetNumberOfInterfaces = Fiddle::Function.new(
  lib['GetNumberOfInterfaces'],
  [
    Fiddle::TYPE_VOIDP,  # pdwNumIf : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetNumberOfInterfaces(
        pdwNumIf: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetNumberOfInterfaces(out uint pdwNumIf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetNumberOfInterfaces' -Namespace Win32 -PassThru
# $api::GetNumberOfInterfaces(pdwNumIf)

#uselib "IPHLPAPI.dll"
#func global GetNumberOfInterfaces "GetNumberOfInterfaces" sptr
; GetNumberOfInterfaces varptr(pdwNumIf)   ; 戻り値は stat
; pdwNumIf : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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