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

MgmGetProtocolOnInterface

関数
指定インターフェイスを所有するプロトコルとコンポーネントを取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

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

パラメーター

名前方向説明
dwIfIndexDWORDin問い合わせる対象インターフェイスのインデックス。
dwIfNextHopAddrDWORDin対象のネクストホップIPアドレス(ネットワークバイト順)。
pdwIfProtocolIdDWORD*inoutそのインターフェイスを所有するプロトコルの識別子を受け取るポインタ。
pdwIfComponentIdDWORD*inout所有プロトコルのコンポーネント識別子を受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; DWORD MgmGetProtocolOnInterface(DWORD dwIfIndex, DWORD dwIfNextHopAddr, DWORD* pdwIfProtocolId, DWORD* pdwIfComponentId)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procMgmGetProtocolOnInterface = rtm.NewProc("MgmGetProtocolOnInterface")
)

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

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

typedef MgmGetProtocolOnInterfaceNative = Uint32 Function(Uint32, Uint32, Pointer<Uint32>, Pointer<Uint32>);
typedef MgmGetProtocolOnInterfaceDart = int Function(int, int, Pointer<Uint32>, Pointer<Uint32>);
final MgmGetProtocolOnInterface = DynamicLibrary.open('rtm.dll')
    .lookupFunction<MgmGetProtocolOnInterfaceNative, MgmGetProtocolOnInterfaceDart>('MgmGetProtocolOnInterface');
// dwIfIndex : DWORD -> Uint32
// dwIfNextHopAddr : DWORD -> Uint32
// pdwIfProtocolId : DWORD* in/out -> Pointer<Uint32>
// pdwIfComponentId : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MgmGetProtocolOnInterface(
  dwIfIndex: DWORD;   // DWORD
  dwIfNextHopAddr: DWORD;   // DWORD
  pdwIfProtocolId: Pointer;   // DWORD* in/out
  pdwIfComponentId: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'rtm.dll' name 'MgmGetProtocolOnInterface';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MgmGetProtocolOnInterface"
  c_MgmGetProtocolOnInterface :: Word32 -> Word32 -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- dwIfIndex : DWORD -> Word32
-- dwIfNextHopAddr : DWORD -> Word32
-- pdwIfProtocolId : DWORD* in/out -> Ptr Word32
-- pdwIfComponentId : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mgmgetprotocoloninterface =
  foreign "MgmGetProtocolOnInterface"
    (uint32_t @-> uint32_t @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* dwIfIndex : DWORD -> uint32_t *)
(* dwIfNextHopAddr : DWORD -> uint32_t *)
(* pdwIfProtocolId : DWORD* in/out -> (ptr uint32_t) *)
(* pdwIfComponentId : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("MgmGetProtocolOnInterface" mgm-get-protocol-on-interface :convention :stdcall) :uint32
  (dw-if-index :uint32)   ; DWORD
  (dw-if-next-hop-addr :uint32)   ; DWORD
  (pdw-if-protocol-id :pointer)   ; DWORD* in/out
  (pdw-if-component-id :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MgmGetProtocolOnInterface = Win32::API::More->new('rtm',
    'DWORD MgmGetProtocolOnInterface(DWORD dwIfIndex, DWORD dwIfNextHopAddr, LPVOID pdwIfProtocolId, LPVOID pdwIfComponentId)');
# my $ret = $MgmGetProtocolOnInterface->Call($dwIfIndex, $dwIfNextHopAddr, $pdwIfProtocolId, $pdwIfComponentId);
# dwIfIndex : DWORD -> DWORD
# dwIfNextHopAddr : DWORD -> DWORD
# pdwIfProtocolId : DWORD* in/out -> LPVOID
# pdwIfComponentId : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。