ホーム › NetworkManagement.IpHelper › GetMulticastIpAddressTable

GetMulticastIpAddressTable

関数

マルチキャストIPアドレスの一覧テーブルを取得する。

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

シグネチャ

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

WIN32_ERROR GetMulticastIpAddressTable(
    ADDRESS_FAMILY Family,
    MIB_MULTICASTIPADDRESS_TABLE** Table
);

パラメーター

名前

型

方向

説明

Family

ADDRESS_FAMILY

取得するアドレスファミリーです。

アドレスファミリーに指定できる値は Winsock2.h ヘッダーファイルに記載されています。AF_ アドレスファミリー定数と PF_ プロトコルファミリー定数の値は同一である(たとえば AF_INET と PF_INET)ため、どちらの定数も使用できます。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更されており、このメンバーに指定できる値は Ws2def.h ヘッダーファイルで定義されています。なお、Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。

現在サポートされている値は AF_INET、AF_INET6、AF_UNSPEC です。

値	意味
AF_UNSPEC 0	アドレスファミリーは未指定です。このパラメーターを指定すると、この関数は IPv4 と IPv6 の両方のエントリを含むマルチキャスト IP アドレステーブルを返します。
AF_INET 2	インターネットプロトコルバージョン 4 (IPv4) のアドレスファミリーです。このパラメーターを指定すると、この関数は IPv4 のエントリのみを含むマルチキャスト IP アドレステーブルを返します。
AF_INET6 23	インターネットプロトコルバージョン 6 (IPv6) のアドレスファミリーです。このパラメーターを指定すると、この関数は IPv6 のエントリのみを含むマルチキャスト IP アドレステーブルを返します。

Table

MIB_MULTICASTIPADDRESS_TABLE**

out

ローカルコンピューター上のエニーキャスト IP アドレスエントリのテーブルを格納する MIB_MULTICASTIPADDRESS_TABLE 構造体へのポインターです。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上のマルチキャスト IP アドレステーブルを取得します。

戻り値

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

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

戻り値	説明
ERROR_INVALID_PARAMETER	関数に無効なパラメーターが渡されました。このエラーは、Table パラメーターに NULL ポインターが渡された場合、または Family パラメーターに AF_INET、AF_INET6、AF_UNSPEC のいずれも指定されなかった場合に返されます。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するために十分なメモリリソースがありません。
ERROR_NOT_FOUND	Family パラメーターで指定されたエニーキャスト IP アドレスエントリが見つかりませんでした。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在せず Family パラメーターに AF_INET が指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在せず Family パラメーターに AF_INET6 が指定された場合にも返されます。さらに、この関数がサポートされていないバージョンの Windows でも返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

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

GetMulticastIpAddressTable 関数は、ローカルシステム上のマルチキャスト IP アドレスを列挙し、その情報を MIB_MULTICASTIPADDRESS_TABLE 構造体で返します。

マルチキャスト IP アドレスのエントリは、Table パラメーターが指すバッファー内の MIB_MULTICASTIPADDRESS_TABLE 構造体で返されます。MIB_MULTICASTIPADDRESS_TABLE 構造体には、マルチキャスト IP アドレスのエントリ数と、各マルチキャスト IP アドレスエントリに対応する MIB_MULTICASTIPADDRESS_ROW 構造体の配列が含まれます。これらの返された構造体が不要になったら、FreeMibTable を呼び出してメモリを解放してください。

Family パラメーターは、AF_INET、AF_INET6、AF_UNSPEC のいずれかに初期化する必要があります。

なお、Table パラメーターが指す、返された MIB_MULTICASTIPADDRESS_TABLE 構造体では、MIB_MULTICASTIPADDRESS_TABLE 構造体の NumEntries メンバーと、Table メンバー内の最初の MIB_MULTICASTIPADDRESS_ROW 配列エントリとの間に、アラインメントのためのパディングが含まれる場合があります。アラインメントのためのパディングは、MIB_MULTICASTIPADDRESS_ROW 配列エントリ間にも存在する場合があります。MIB_MULTICASTIPADDRESS_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 GetMulticastIpAddressTable(
    ADDRESS_FAMILY Family,
    MIB_MULTICASTIPADDRESS_TABLE** Table
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint GetMulticastIpAddressTable(
    ushort Family,   // ADDRESS_FAMILY
    IntPtr Table   // MIB_MULTICASTIPADDRESS_TABLE** out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function GetMulticastIpAddressTable(
    Family As UShort,   ' ADDRESS_FAMILY
    Table As IntPtr   ' MIB_MULTICASTIPADDRESS_TABLE** out
) As UInteger
End Function

' Family : ADDRESS_FAMILY
' Table : MIB_MULTICASTIPADDRESS_TABLE** out
Declare PtrSafe Function GetMulticastIpAddressTable Lib "iphlpapi" ( _
    ByVal Family As Integer, _
    ByVal Table As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetMulticastIpAddressTable = ctypes.windll.iphlpapi.GetMulticastIpAddressTable
GetMulticastIpAddressTable.restype = wintypes.DWORD
GetMulticastIpAddressTable.argtypes = [
    ctypes.c_ushort,  # Family : ADDRESS_FAMILY
    ctypes.c_void_p,  # Table : MIB_MULTICASTIPADDRESS_TABLE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
GetMulticastIpAddressTable = Fiddle::Function.new(
  lib['GetMulticastIpAddressTable'],
  [
    -Fiddle::TYPE_SHORT,  # Family : ADDRESS_FAMILY
    Fiddle::TYPE_VOIDP,  # Table : MIB_MULTICASTIPADDRESS_TABLE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn GetMulticastIpAddressTable(
        Family: u16,  // ADDRESS_FAMILY
        Table: *mut *mut MIB_MULTICASTIPADDRESS_TABLE  // MIB_MULTICASTIPADDRESS_TABLE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint GetMulticastIpAddressTable(ushort Family, IntPtr Table);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_GetMulticastIpAddressTable' -Namespace Win32 -PassThru
# $api::GetMulticastIpAddressTable(Family, Table)

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

出力引数:

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