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

MprConfigInterfaceTransportGetInfo

関数
構成内インターフェイスのトランスポートの情報を取得する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MprConfigInterfaceTransportGetInfo(
    HANDLE hMprConfig,
    HANDLE hRouterInterface,
    HANDLE hRouterIfTransport,
    BYTE** ppInterfaceInfo,   // optional
    DWORD* lpdwInterfaceInfoSize   // optional
);

パラメーター

名前方向説明
hMprConfigHANDLEinMprConfigServerConnectで取得した構成ハンドル。
hRouterInterfaceHANDLEin対象インターフェイスのハンドル。
hRouterIfTransportHANDLEin情報を取得するインターフェイス上トランスポートのハンドル。
ppInterfaceInfoBYTE**outoptionalインターフェイス固有トランスポート情報バッファへのポインタを受け取る。MprConfigBufferFreeで解放する。
lpdwInterfaceInfoSizeDWORD*outoptional返されたバッファのサイズ(バイト単位)を受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MprConfigInterfaceTransportGetInfo(
    HANDLE hMprConfig,
    HANDLE hRouterInterface,
    HANDLE hRouterIfTransport,
    BYTE** ppInterfaceInfo,   // optional
    DWORD* lpdwInterfaceInfoSize   // optional
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprConfigInterfaceTransportGetInfo(
    IntPtr hMprConfig,   // HANDLE
    IntPtr hRouterInterface,   // HANDLE
    IntPtr hRouterIfTransport,   // HANDLE
    IntPtr ppInterfaceInfo,   // BYTE** optional, out
    IntPtr lpdwInterfaceInfoSize   // DWORD* optional, out
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprConfigInterfaceTransportGetInfo(
    hMprConfig As IntPtr,   ' HANDLE
    hRouterInterface As IntPtr,   ' HANDLE
    hRouterIfTransport As IntPtr,   ' HANDLE
    ppInterfaceInfo As IntPtr,   ' BYTE** optional, out
    lpdwInterfaceInfoSize As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' hMprConfig : HANDLE
' hRouterInterface : HANDLE
' hRouterIfTransport : HANDLE
' ppInterfaceInfo : BYTE** optional, out
' lpdwInterfaceInfoSize : DWORD* optional, out
Declare PtrSafe Function MprConfigInterfaceTransportGetInfo Lib "mprapi" ( _
    ByVal hMprConfig As LongPtr, _
    ByVal hRouterInterface As LongPtr, _
    ByVal hRouterIfTransport As LongPtr, _
    ByVal ppInterfaceInfo As LongPtr, _
    ByVal lpdwInterfaceInfoSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MprConfigInterfaceTransportGetInfo = ctypes.windll.mprapi.MprConfigInterfaceTransportGetInfo
MprConfigInterfaceTransportGetInfo.restype = wintypes.DWORD
MprConfigInterfaceTransportGetInfo.argtypes = [
    wintypes.HANDLE,  # hMprConfig : HANDLE
    wintypes.HANDLE,  # hRouterInterface : HANDLE
    wintypes.HANDLE,  # hRouterIfTransport : HANDLE
    ctypes.c_void_p,  # ppInterfaceInfo : BYTE** optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpdwInterfaceInfoSize : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprConfigInterfaceTransportGetInfo = Fiddle::Function.new(
  lib['MprConfigInterfaceTransportGetInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hMprConfig : HANDLE
    Fiddle::TYPE_VOIDP,  # hRouterInterface : HANDLE
    Fiddle::TYPE_VOIDP,  # hRouterIfTransport : HANDLE
    Fiddle::TYPE_VOIDP,  # ppInterfaceInfo : BYTE** optional, out
    Fiddle::TYPE_VOIDP,  # lpdwInterfaceInfoSize : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprConfigInterfaceTransportGetInfo(
        hMprConfig: *mut core::ffi::c_void,  // HANDLE
        hRouterInterface: *mut core::ffi::c_void,  // HANDLE
        hRouterIfTransport: *mut core::ffi::c_void,  // HANDLE
        ppInterfaceInfo: *mut *mut u8,  // BYTE** optional, out
        lpdwInterfaceInfoSize: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPRAPI.dll")]
public static extern uint MprConfigInterfaceTransportGetInfo(IntPtr hMprConfig, IntPtr hRouterInterface, IntPtr hRouterIfTransport, IntPtr ppInterfaceInfo, IntPtr lpdwInterfaceInfoSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprConfigInterfaceTransportGetInfo' -Namespace Win32 -PassThru
# $api::MprConfigInterfaceTransportGetInfo(hMprConfig, hRouterInterface, hRouterIfTransport, ppInterfaceInfo, lpdwInterfaceInfoSize)
#uselib "MPRAPI.dll"
#func global MprConfigInterfaceTransportGetInfo "MprConfigInterfaceTransportGetInfo" sptr, sptr, sptr, sptr, sptr
; MprConfigInterfaceTransportGetInfo hMprConfig, hRouterInterface, hRouterIfTransport, varptr(ppInterfaceInfo), varptr(lpdwInterfaceInfoSize)   ; 戻り値は stat
; hMprConfig : HANDLE -> "sptr"
; hRouterInterface : HANDLE -> "sptr"
; hRouterIfTransport : HANDLE -> "sptr"
; ppInterfaceInfo : BYTE** optional, out -> "sptr"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPRAPI.dll"
#cfunc global MprConfigInterfaceTransportGetInfo "MprConfigInterfaceTransportGetInfo" sptr, sptr, sptr, var, var
; res = MprConfigInterfaceTransportGetInfo(hMprConfig, hRouterInterface, hRouterIfTransport, ppInterfaceInfo, lpdwInterfaceInfoSize)
; hMprConfig : HANDLE -> "sptr"
; hRouterInterface : HANDLE -> "sptr"
; hRouterIfTransport : HANDLE -> "sptr"
; ppInterfaceInfo : BYTE** optional, out -> "var"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MprConfigInterfaceTransportGetInfo(HANDLE hMprConfig, HANDLE hRouterInterface, HANDLE hRouterIfTransport, BYTE** ppInterfaceInfo, DWORD* lpdwInterfaceInfoSize)
#uselib "MPRAPI.dll"
#cfunc global MprConfigInterfaceTransportGetInfo "MprConfigInterfaceTransportGetInfo" intptr, intptr, intptr, var, var
; res = MprConfigInterfaceTransportGetInfo(hMprConfig, hRouterInterface, hRouterIfTransport, ppInterfaceInfo, lpdwInterfaceInfoSize)
; hMprConfig : HANDLE -> "intptr"
; hRouterInterface : HANDLE -> "intptr"
; hRouterIfTransport : HANDLE -> "intptr"
; ppInterfaceInfo : BYTE** optional, out -> "var"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprConfigInterfaceTransportGetInfo = mprapi.NewProc("MprConfigInterfaceTransportGetInfo")
)

// hMprConfig (HANDLE), hRouterInterface (HANDLE), hRouterIfTransport (HANDLE), ppInterfaceInfo (BYTE** optional, out), lpdwInterfaceInfoSize (DWORD* optional, out)
r1, _, err := procMprConfigInterfaceTransportGetInfo.Call(
	uintptr(hMprConfig),
	uintptr(hRouterInterface),
	uintptr(hRouterIfTransport),
	uintptr(ppInterfaceInfo),
	uintptr(lpdwInterfaceInfoSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MprConfigInterfaceTransportGetInfo(
  hMprConfig: THandle;   // HANDLE
  hRouterInterface: THandle;   // HANDLE
  hRouterIfTransport: THandle;   // HANDLE
  ppInterfaceInfo: Pointer;   // BYTE** optional, out
  lpdwInterfaceInfoSize: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprConfigInterfaceTransportGetInfo';
result := DllCall("MPRAPI\MprConfigInterfaceTransportGetInfo"
    , "Ptr", hMprConfig   ; HANDLE
    , "Ptr", hRouterInterface   ; HANDLE
    , "Ptr", hRouterIfTransport   ; HANDLE
    , "Ptr", ppInterfaceInfo   ; BYTE** optional, out
    , "Ptr", lpdwInterfaceInfoSize   ; DWORD* optional, out
    , "UInt")   ; return: DWORD
●MprConfigInterfaceTransportGetInfo(hMprConfig, hRouterInterface, hRouterIfTransport, ppInterfaceInfo, lpdwInterfaceInfoSize) = DLL("MPRAPI.dll", "dword MprConfigInterfaceTransportGetInfo(void*, void*, void*, void*, void*)")
# 呼び出し: MprConfigInterfaceTransportGetInfo(hMprConfig, hRouterInterface, hRouterIfTransport, ppInterfaceInfo, lpdwInterfaceInfoSize)
# hMprConfig : HANDLE -> "void*"
# hRouterInterface : HANDLE -> "void*"
# hRouterIfTransport : HANDLE -> "void*"
# ppInterfaceInfo : BYTE** optional, out -> "void*"
# lpdwInterfaceInfoSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MprConfigInterfaceTransportGetInfoNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
typedef MprConfigInterfaceTransportGetInfoDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Uint8>, Pointer<Uint32>);
final MprConfigInterfaceTransportGetInfo = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprConfigInterfaceTransportGetInfoNative, MprConfigInterfaceTransportGetInfoDart>('MprConfigInterfaceTransportGetInfo');
// hMprConfig : HANDLE -> Pointer<Void>
// hRouterInterface : HANDLE -> Pointer<Void>
// hRouterIfTransport : HANDLE -> Pointer<Void>
// ppInterfaceInfo : BYTE** optional, out -> Pointer<Uint8>
// lpdwInterfaceInfoSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprConfigInterfaceTransportGetInfo(
  hMprConfig: THandle;   // HANDLE
  hRouterInterface: THandle;   // HANDLE
  hRouterIfTransport: THandle;   // HANDLE
  ppInterfaceInfo: Pointer;   // BYTE** optional, out
  lpdwInterfaceInfoSize: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprConfigInterfaceTransportGetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprConfigInterfaceTransportGetInfo"
  c_MprConfigInterfaceTransportGetInfo :: Ptr () -> Ptr () -> Ptr () -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- hMprConfig : HANDLE -> Ptr ()
-- hRouterInterface : HANDLE -> Ptr ()
-- hRouterIfTransport : HANDLE -> Ptr ()
-- ppInterfaceInfo : BYTE** optional, out -> Ptr Word8
-- lpdwInterfaceInfoSize : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mprconfiginterfacetransportgetinfo =
  foreign "MprConfigInterfaceTransportGetInfo"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hMprConfig : HANDLE -> (ptr void) *)
(* hRouterInterface : HANDLE -> (ptr void) *)
(* hRouterIfTransport : HANDLE -> (ptr void) *)
(* ppInterfaceInfo : BYTE** optional, out -> (ptr uint8_t) *)
(* lpdwInterfaceInfoSize : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprConfigInterfaceTransportGetInfo" mpr-config-interface-transport-get-info :convention :stdcall) :uint32
  (h-mpr-config :pointer)   ; HANDLE
  (h-router-interface :pointer)   ; HANDLE
  (h-router-if-transport :pointer)   ; HANDLE
  (pp-interface-info :pointer)   ; BYTE** optional, out
  (lpdw-interface-info-size :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprConfigInterfaceTransportGetInfo = Win32::API::More->new('MPRAPI',
    'DWORD MprConfigInterfaceTransportGetInfo(HANDLE hMprConfig, HANDLE hRouterInterface, HANDLE hRouterIfTransport, LPVOID ppInterfaceInfo, LPVOID lpdwInterfaceInfoSize)');
# my $ret = $MprConfigInterfaceTransportGetInfo->Call($hMprConfig, $hRouterInterface, $hRouterIfTransport, $ppInterfaceInfo, $lpdwInterfaceInfoSize);
# hMprConfig : HANDLE -> HANDLE
# hRouterInterface : HANDLE -> HANDLE
# hRouterIfTransport : HANDLE -> HANDLE
# ppInterfaceInfo : BYTE** optional, out -> LPVOID
# lpdwInterfaceInfoSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。