ホーム › NetworkManagement.Rras › MgmGetProtocolOnInterface

MgmGetProtocolOnInterface

関数

指定インターフェイスを所有するプロトコルとコンポーネントを取得する。

DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MgmGetProtocolOnInterface(
    DWORD dwIfIndex,
    DWORD dwIfNextHopAddr,
    DWORD* pdwIfProtocolId,
    DWORD* pdwIfComponentId
);

パラメーター

名前	型	方向	説明
dwIfIndex	DWORD	in	プロトコル ID を取得する対象のインターフェイスのインデックスを指定します。
dwIfNextHopAddr	DWORD	in	dwIfIndex で指定されたインデックスに対応するネクストホップのアドレスを指定します。dwIfIndex パラメーターと dwIfNextHopIPAddr パラメーターにより、ポイントツーマルチポイントインターフェイス上のネクストホップが一意に識別されます。ポイントツーマルチポイントインターフェイスとは、1 つのインターフェイスが複数のネットワークに接続する接続形態です。ポイントツーマルチポイントインターフェイスの例としては、非ブロードキャストマルチアクセス (NBMA) インターフェイスや、すべてのダイヤルアップクライアントが接続する内部インターフェイスがあります。ブロードキャストインターフェイス (イーサネットインターフェイスなど) や、dwIfIndex の値のみで識別されるポイントツーポイントインターフェイスの場合は、0 を指定します。
pdwIfProtocolId	DWORD*	inout	入力時、クライアントは DWORD サイズのメモリ位置へのポインターを指定する必要があります。出力時、pdwIfProtocolId は dwIfIndex で指定されたインターフェイス上のプロトコルの ID を受け取ります。
pdwIfComponentId	DWORD*	inout	入力時、クライアントは DWORD 値へのポインターを指定する必要があります。出力時、pdwIfComponentId はインターフェイス上のプロトコルインスタンスのコンポーネント ID を受け取ります。このパラメーターは、pdwIfProtocolId と共に使用して、ルーティングプロトコルのインスタンスを一意に識別します。

戻り値の型: DWORD

公式ドキュメント

MgmGetProtocolOnInterface 関数は、指定されたインターフェイスを所有するマルチキャストルーティングプロトコルのプロトコル ID を取得します。

戻り値

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

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

値	意味
ERROR_CAN_NOT_COMPLETE	この関数の呼び出しを完了できませんでした。
ERROR_NOT_FOUND	指定されたインターフェイスがマルチキャストグループマネージャーによって見つかりませんでした。

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

各言語での呼び出し定義

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

DWORD MgmGetProtocolOnInterface(
    DWORD dwIfIndex,
    DWORD dwIfNextHopAddr,
    DWORD* pdwIfProtocolId,
    DWORD* pdwIfComponentId
);

[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint MgmGetProtocolOnInterface(
    uint dwIfIndex,   // DWORD
    uint dwIfNextHopAddr,   // DWORD
    ref uint pdwIfProtocolId,   // DWORD* in/out
    ref uint pdwIfComponentId   // DWORD* in/out
);

<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function MgmGetProtocolOnInterface(
    dwIfIndex As UInteger,   ' DWORD
    dwIfNextHopAddr As UInteger,   ' DWORD
    ByRef pdwIfProtocolId As UInteger,   ' DWORD* in/out
    ByRef pdwIfComponentId As UInteger   ' DWORD* in/out
) As UInteger
End Function

' dwIfIndex : DWORD
' dwIfNextHopAddr : DWORD
' pdwIfProtocolId : DWORD* in/out
' pdwIfComponentId : DWORD* in/out
Declare PtrSafe Function MgmGetProtocolOnInterface Lib "rtm" ( _
    ByVal dwIfIndex As Long, _
    ByVal dwIfNextHopAddr As Long, _
    ByRef pdwIfProtocolId As Long, _
    ByRef pdwIfComponentId As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MgmGetProtocolOnInterface = ctypes.windll.rtm.MgmGetProtocolOnInterface
MgmGetProtocolOnInterface.restype = wintypes.DWORD
MgmGetProtocolOnInterface.argtypes = [
    wintypes.DWORD,  # dwIfIndex : DWORD
    wintypes.DWORD,  # dwIfNextHopAddr : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pdwIfProtocolId : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwIfComponentId : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtm.dll')
MgmGetProtocolOnInterface = Fiddle::Function.new(
  lib['MgmGetProtocolOnInterface'],
  [
    -Fiddle::TYPE_INT,  # dwIfIndex : DWORD
    -Fiddle::TYPE_INT,  # dwIfNextHopAddr : DWORD
    Fiddle::TYPE_VOIDP,  # pdwIfProtocolId : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pdwIfComponentId : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "rtm")]
extern "system" {
    fn MgmGetProtocolOnInterface(
        dwIfIndex: u32,  // DWORD
        dwIfNextHopAddr: u32,  // DWORD
        pdwIfProtocolId: *mut u32,  // DWORD* in/out
        pdwIfComponentId: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("rtm.dll")]
public static extern uint MgmGetProtocolOnInterface(uint dwIfIndex, uint dwIfNextHopAddr, ref uint pdwIfProtocolId, ref uint pdwIfComponentId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtm_MgmGetProtocolOnInterface' -Namespace Win32 -PassThru
# $api::MgmGetProtocolOnInterface(dwIfIndex, dwIfNextHopAddr, pdwIfProtocolId, pdwIfComponentId)

#uselib "rtm.dll"
#func global MgmGetProtocolOnInterface "MgmGetProtocolOnInterface" sptr, sptr, sptr, sptr
; MgmGetProtocolOnInterface dwIfIndex, dwIfNextHopAddr, varptr(pdwIfProtocolId), varptr(pdwIfComponentId)   ; 戻り値は stat
; dwIfIndex : DWORD -> "sptr"
; dwIfNextHopAddr : DWORD -> "sptr"
; pdwIfProtocolId : DWORD* in/out -> "sptr"
; pdwIfComponentId : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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