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

MprAdminInterfaceTransportGetInfo

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

シグネチャ

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

DWORD MprAdminInterfaceTransportGetInfo(
    INT_PTR hMprServer,
    HANDLE hInterface,
    DWORD dwTransportId,
    BYTE** ppInterfaceInfo,
    DWORD* lpdwInterfaceInfoSize   // optional
);

パラメーター

名前方向説明
hMprServerINT_PTRinMprAdminServerConnectで取得したMPRサーバーハンドル(INT_PTR)。
hInterfaceHANDLEin対象インターフェイスのハンドル。
dwTransportIdDWORDin情報を取得するトランスポートの識別子(PID_IP等)。
ppInterfaceInfoBYTE**out確保されたトランスポート固有構成バッファへのポインタを受け取る変数。MprAdminBufferFreeで解放する。
lpdwInterfaceInfoSizeDWORD*outoptional構成情報のサイズ(バイト)を受け取る変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MprAdminInterfaceTransportGetInfo(
    INT_PTR hMprServer,
    HANDLE hInterface,
    DWORD dwTransportId,
    BYTE** ppInterfaceInfo,
    DWORD* lpdwInterfaceInfoSize   // optional
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprAdminInterfaceTransportGetInfo(
    IntPtr hMprServer,   // INT_PTR
    IntPtr hInterface,   // HANDLE
    uint dwTransportId,   // DWORD
    IntPtr ppInterfaceInfo,   // BYTE** out
    IntPtr lpdwInterfaceInfoSize   // DWORD* optional, out
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprAdminInterfaceTransportGetInfo(
    hMprServer As IntPtr,   ' INT_PTR
    hInterface As IntPtr,   ' HANDLE
    dwTransportId As UInteger,   ' DWORD
    ppInterfaceInfo As IntPtr,   ' BYTE** out
    lpdwInterfaceInfoSize As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' hMprServer : INT_PTR
' hInterface : HANDLE
' dwTransportId : DWORD
' ppInterfaceInfo : BYTE** out
' lpdwInterfaceInfoSize : DWORD* optional, out
Declare PtrSafe Function MprAdminInterfaceTransportGetInfo Lib "mprapi" ( _
    ByVal hMprServer As LongPtr, _
    ByVal hInterface As LongPtr, _
    ByVal dwTransportId As Long, _
    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

MprAdminInterfaceTransportGetInfo = ctypes.windll.mprapi.MprAdminInterfaceTransportGetInfo
MprAdminInterfaceTransportGetInfo.restype = wintypes.DWORD
MprAdminInterfaceTransportGetInfo.argtypes = [
    ctypes.c_ssize_t,  # hMprServer : INT_PTR
    wintypes.HANDLE,  # hInterface : HANDLE
    wintypes.DWORD,  # dwTransportId : DWORD
    ctypes.c_void_p,  # ppInterfaceInfo : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # lpdwInterfaceInfoSize : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprAdminInterfaceTransportGetInfo = Fiddle::Function.new(
  lib['MprAdminInterfaceTransportGetInfo'],
  [
    Fiddle::TYPE_INTPTR_T,  # hMprServer : INT_PTR
    Fiddle::TYPE_VOIDP,  # hInterface : HANDLE
    -Fiddle::TYPE_INT,  # dwTransportId : DWORD
    Fiddle::TYPE_VOIDP,  # ppInterfaceInfo : BYTE** out
    Fiddle::TYPE_VOIDP,  # lpdwInterfaceInfoSize : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprAdminInterfaceTransportGetInfo(
        hMprServer: isize,  // INT_PTR
        hInterface: *mut core::ffi::c_void,  // HANDLE
        dwTransportId: u32,  // DWORD
        ppInterfaceInfo: *mut *mut u8,  // BYTE** 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 MprAdminInterfaceTransportGetInfo(IntPtr hMprServer, IntPtr hInterface, uint dwTransportId, IntPtr ppInterfaceInfo, IntPtr lpdwInterfaceInfoSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprAdminInterfaceTransportGetInfo' -Namespace Win32 -PassThru
# $api::MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
#uselib "MPRAPI.dll"
#func global MprAdminInterfaceTransportGetInfo "MprAdminInterfaceTransportGetInfo" sptr, sptr, sptr, sptr, sptr
; MprAdminInterfaceTransportGetInfo hMprServer, hInterface, dwTransportId, varptr(ppInterfaceInfo), varptr(lpdwInterfaceInfoSize)   ; 戻り値は stat
; hMprServer : INT_PTR -> "sptr"
; hInterface : HANDLE -> "sptr"
; dwTransportId : DWORD -> "sptr"
; ppInterfaceInfo : BYTE** out -> "sptr"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceTransportGetInfo "MprAdminInterfaceTransportGetInfo" sptr, sptr, int, var, var
; res = MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
; hMprServer : INT_PTR -> "sptr"
; hInterface : HANDLE -> "sptr"
; dwTransportId : DWORD -> "int"
; ppInterfaceInfo : BYTE** out -> "var"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MprAdminInterfaceTransportGetInfo(INT_PTR hMprServer, HANDLE hInterface, DWORD dwTransportId, BYTE** ppInterfaceInfo, DWORD* lpdwInterfaceInfoSize)
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceTransportGetInfo "MprAdminInterfaceTransportGetInfo" intptr, intptr, int, var, var
; res = MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
; hMprServer : INT_PTR -> "intptr"
; hInterface : HANDLE -> "intptr"
; dwTransportId : DWORD -> "int"
; ppInterfaceInfo : BYTE** out -> "var"
; lpdwInterfaceInfoSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminInterfaceTransportGetInfo = mprapi.NewProc("MprAdminInterfaceTransportGetInfo")
)

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

extern "mprapi" fn MprAdminInterfaceTransportGetInfo(
    hMprServer: isize, // INT_PTR
    hInterface: ?*anyopaque, // HANDLE
    dwTransportId: u32, // DWORD
    ppInterfaceInfo: [*c][*c]u8, // BYTE** out
    lpdwInterfaceInfoSize: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc MprAdminInterfaceTransportGetInfo(
    hMprServer: int,  # INT_PTR
    hInterface: pointer,  # HANDLE
    dwTransportId: uint32,  # DWORD
    ppInterfaceInfo: ptr uint8,  # BYTE** out
    lpdwInterfaceInfoSize: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "MprAdminInterfaceTransportGetInfo", stdcall, dynlib: "MPRAPI.dll".}
pragma(lib, "mprapi");
extern(Windows)
uint MprAdminInterfaceTransportGetInfo(
    ptrdiff_t hMprServer,   // INT_PTR
    void* hInterface,   // HANDLE
    uint dwTransportId,   // DWORD
    ubyte** ppInterfaceInfo,   // BYTE** out
    uint* lpdwInterfaceInfoSize   // DWORD* optional, out
);
ccall((:MprAdminInterfaceTransportGetInfo, "MPRAPI.dll"), stdcall, UInt32,
      (Int, Ptr{Cvoid}, UInt32, Ptr{UInt8}, Ptr{UInt32}),
      hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
# hMprServer : INT_PTR -> Int
# hInterface : HANDLE -> Ptr{Cvoid}
# dwTransportId : DWORD -> UInt32
# ppInterfaceInfo : BYTE** out -> Ptr{UInt8}
# lpdwInterfaceInfoSize : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MprAdminInterfaceTransportGetInfo(
    intptr_t hMprServer,
    void* hInterface,
    uint32_t dwTransportId,
    uint8_t** ppInterfaceInfo,
    uint32_t* lpdwInterfaceInfoSize);
]]
local mprapi = ffi.load("mprapi")
-- mprapi.MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
-- hMprServer : INT_PTR
-- hInterface : HANDLE
-- dwTransportId : DWORD
-- ppInterfaceInfo : BYTE** out
-- lpdwInterfaceInfoSize : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MPRAPI.dll');
const MprAdminInterfaceTransportGetInfo = lib.func('__stdcall', 'MprAdminInterfaceTransportGetInfo', 'uint32_t', ['intptr_t', 'void *', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
// hMprServer : INT_PTR -> 'intptr_t'
// hInterface : HANDLE -> 'void *'
// dwTransportId : DWORD -> 'uint32_t'
// ppInterfaceInfo : BYTE** out -> 'uint8_t *'
// lpdwInterfaceInfoSize : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPRAPI.dll", {
  MprAdminInterfaceTransportGetInfo: { parameters: ["isize", "pointer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize)
// hMprServer : INT_PTR -> "isize"
// hInterface : HANDLE -> "pointer"
// dwTransportId : DWORD -> "u32"
// ppInterfaceInfo : BYTE** out -> "pointer"
// lpdwInterfaceInfoSize : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MprAdminInterfaceTransportGetInfo(
    intptr_t hMprServer,
    void* hInterface,
    uint32_t dwTransportId,
    uint8_t** ppInterfaceInfo,
    uint32_t* lpdwInterfaceInfoSize);
C, "MPRAPI.dll");
// $ffi->MprAdminInterfaceTransportGetInfo(hMprServer, hInterface, dwTransportId, ppInterfaceInfo, lpdwInterfaceInfoSize);
// hMprServer : INT_PTR
// hInterface : HANDLE
// dwTransportId : DWORD
// ppInterfaceInfo : BYTE** 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 MprAdminInterfaceTransportGetInfo(
        long hMprServer,   // INT_PTR
        Pointer hInterface,   // HANDLE
        int dwTransportId,   // DWORD
        Pointer ppInterfaceInfo,   // BYTE** out
        IntByReference lpdwInterfaceInfoSize   // DWORD* optional, out
    );
}
@[Link("mprapi")]
lib LibMPRAPI
  fun MprAdminInterfaceTransportGetInfo = MprAdminInterfaceTransportGetInfo(
    hMprServer : LibC::SSizeT,   # INT_PTR
    hInterface : Void*,   # HANDLE
    dwTransportId : UInt32,   # DWORD
    ppInterfaceInfo : UInt8**,   # BYTE** 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 MprAdminInterfaceTransportGetInfoNative = Uint32 Function(IntPtr, Pointer<Void>, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef MprAdminInterfaceTransportGetInfoDart = int Function(int, Pointer<Void>, int, Pointer<Uint8>, Pointer<Uint32>);
final MprAdminInterfaceTransportGetInfo = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminInterfaceTransportGetInfoNative, MprAdminInterfaceTransportGetInfoDart>('MprAdminInterfaceTransportGetInfo');
// hMprServer : INT_PTR -> IntPtr
// hInterface : HANDLE -> Pointer<Void>
// dwTransportId : DWORD -> Uint32
// ppInterfaceInfo : BYTE** out -> Pointer<Uint8>
// lpdwInterfaceInfoSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminInterfaceTransportGetInfo(
  hMprServer: NativeInt;   // INT_PTR
  hInterface: THandle;   // HANDLE
  dwTransportId: DWORD;   // DWORD
  ppInterfaceInfo: Pointer;   // BYTE** out
  lpdwInterfaceInfoSize: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminInterfaceTransportGetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let mpradmininterfacetransportgetinfo =
  foreign "MprAdminInterfaceTransportGetInfo"
    (intptr_t @-> (ptr void) @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hMprServer : INT_PTR -> intptr_t *)
(* hInterface : HANDLE -> (ptr void) *)
(* dwTransportId : DWORD -> uint32_t *)
(* ppInterfaceInfo : BYTE** 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 ("MprAdminInterfaceTransportGetInfo" mpr-admin-interface-transport-get-info :convention :stdcall) :uint32
  (h-mpr-server :int64)   ; INT_PTR
  (h-interface :pointer)   ; HANDLE
  (dw-transport-id :uint32)   ; DWORD
  (pp-interface-info :pointer)   ; BYTE** 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 $MprAdminInterfaceTransportGetInfo = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminInterfaceTransportGetInfo(LPARAM hMprServer, HANDLE hInterface, DWORD dwTransportId, LPVOID ppInterfaceInfo, LPVOID lpdwInterfaceInfoSize)');
# my $ret = $MprAdminInterfaceTransportGetInfo->Call($hMprServer, $hInterface, $dwTransportId, $ppInterfaceInfo, $lpdwInterfaceInfoSize);
# hMprServer : INT_PTR -> LPARAM
# hInterface : HANDLE -> HANDLE
# dwTransportId : DWORD -> DWORD
# ppInterfaceInfo : BYTE** out -> LPVOID
# lpdwInterfaceInfoSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。