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

MprAdminPortGetInfo

関数
RASサーバー上の指定ポートの情報を取得する。
DLLMPRAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD MprAdminPortGetInfo(
    INT_PTR hRasServer,
    DWORD dwLevel,
    HANDLE hPort,
    BYTE** lplpbBuffer
);

パラメーター

名前方向説明
hRasServerINT_PTRinMprAdminServerConnectで取得したRASサーバー接続ハンドル(INT_PTR)。
dwLevelDWORDin取得する情報レベル(0または1)。返却構造体の種類を決める。
hPortHANDLEin情報を取得する対象のポートハンドル。
lplpbBufferBYTE**out確保されたポート情報バッファへのポインタを受け取る変数。MprAdminBufferFreeで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

MprAdminPortGetInfo = ctypes.windll.mprapi.MprAdminPortGetInfo
MprAdminPortGetInfo.restype = wintypes.DWORD
MprAdminPortGetInfo.argtypes = [
    ctypes.c_ssize_t,  # hRasServer : INT_PTR
    wintypes.DWORD,  # dwLevel : DWORD
    wintypes.HANDLE,  # hPort : HANDLE
    ctypes.c_void_p,  # lplpbBuffer : BYTE** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminPortGetInfo = mprapi.NewProc("MprAdminPortGetInfo")
)

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

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

typedef MprAdminPortGetInfoNative = Uint32 Function(IntPtr, Uint32, Pointer<Void>, Pointer<Uint8>);
typedef MprAdminPortGetInfoDart = int Function(int, int, Pointer<Void>, Pointer<Uint8>);
final MprAdminPortGetInfo = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminPortGetInfoNative, MprAdminPortGetInfoDart>('MprAdminPortGetInfo');
// hRasServer : INT_PTR -> IntPtr
// dwLevel : DWORD -> Uint32
// hPort : HANDLE -> Pointer<Void>
// lplpbBuffer : BYTE** out -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminPortGetInfo(
  hRasServer: NativeInt;   // INT_PTR
  dwLevel: DWORD;   // DWORD
  hPort: THandle;   // HANDLE
  lplpbBuffer: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminPortGetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminPortGetInfo"
  c_MprAdminPortGetInfo :: CIntPtr -> Word32 -> Ptr () -> Ptr Word8 -> IO Word32
-- hRasServer : INT_PTR -> CIntPtr
-- dwLevel : DWORD -> Word32
-- hPort : HANDLE -> Ptr ()
-- lplpbBuffer : BYTE** out -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradminportgetinfo =
  foreign "MprAdminPortGetInfo"
    (intptr_t @-> uint32_t @-> (ptr void) @-> (ptr uint8_t) @-> returning uint32_t)
(* hRasServer : INT_PTR -> intptr_t *)
(* dwLevel : DWORD -> uint32_t *)
(* hPort : HANDLE -> (ptr void) *)
(* lplpbBuffer : BYTE** out -> (ptr uint8_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminPortGetInfo" mpr-admin-port-get-info :convention :stdcall) :uint32
  (h-ras-server :int64)   ; INT_PTR
  (dw-level :uint32)   ; DWORD
  (h-port :pointer)   ; HANDLE
  (lplpb-buffer :pointer))   ; BYTE** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminPortGetInfo = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminPortGetInfo(LPARAM hRasServer, DWORD dwLevel, HANDLE hPort, LPVOID lplpbBuffer)');
# my $ret = $MprAdminPortGetInfo->Call($hRasServer, $dwLevel, $hPort, $lplpbBuffer);
# hRasServer : INT_PTR -> LPARAM
# dwLevel : DWORD -> DWORD
# hPort : HANDLE -> HANDLE
# lplpbBuffer : BYTE** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。