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

MprAdminInterfaceUpdateRoutes

関数
指定プロトコルでインターフェイスのルート情報を更新する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MprAdminInterfaceUpdateRoutes(
    INT_PTR hMprServer,
    HANDLE hInterface,
    DWORD dwProtocolId,
    HANDLE hEvent
);

パラメーター

名前方向説明
hMprServerINT_PTRinMprAdminServerConnectで取得したRRASサーバー接続ハンドル。ローカルはNULL可。
hInterfaceHANDLEinルートを更新する対象インターフェイスのハンドル。
dwProtocolIdDWORDinルート更新を要求するルーティングプロトコルの識別子(PROTO_IP_RIP等)。
hEventHANDLEin更新完了を通知するイベントオブジェクトのハンドル。不要ならNULL可。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

MprAdminInterfaceUpdateRoutes = ctypes.windll.mprapi.MprAdminInterfaceUpdateRoutes
MprAdminInterfaceUpdateRoutes.restype = wintypes.DWORD
MprAdminInterfaceUpdateRoutes.argtypes = [
    ctypes.c_ssize_t,  # hMprServer : INT_PTR
    wintypes.HANDLE,  # hInterface : HANDLE
    wintypes.DWORD,  # dwProtocolId : DWORD
    wintypes.HANDLE,  # hEvent : HANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprAdminInterfaceUpdateRoutes = Fiddle::Function.new(
  lib['MprAdminInterfaceUpdateRoutes'],
  [
    Fiddle::TYPE_INTPTR_T,  # hMprServer : INT_PTR
    Fiddle::TYPE_VOIDP,  # hInterface : HANDLE
    -Fiddle::TYPE_INT,  # dwProtocolId : DWORD
    Fiddle::TYPE_VOIDP,  # hEvent : HANDLE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprAdminInterfaceUpdateRoutes(
        hMprServer: isize,  // INT_PTR
        hInterface: *mut core::ffi::c_void,  // HANDLE
        dwProtocolId: u32,  // DWORD
        hEvent: *mut core::ffi::c_void  // HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPRAPI.dll")]
public static extern uint MprAdminInterfaceUpdateRoutes(IntPtr hMprServer, IntPtr hInterface, uint dwProtocolId, IntPtr hEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprAdminInterfaceUpdateRoutes' -Namespace Win32 -PassThru
# $api::MprAdminInterfaceUpdateRoutes(hMprServer, hInterface, dwProtocolId, hEvent)
#uselib "MPRAPI.dll"
#func global MprAdminInterfaceUpdateRoutes "MprAdminInterfaceUpdateRoutes" sptr, sptr, sptr, sptr
; MprAdminInterfaceUpdateRoutes hMprServer, hInterface, dwProtocolId, hEvent   ; 戻り値は stat
; hMprServer : INT_PTR -> "sptr"
; hInterface : HANDLE -> "sptr"
; dwProtocolId : DWORD -> "sptr"
; hEvent : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceUpdateRoutes "MprAdminInterfaceUpdateRoutes" sptr, sptr, int, sptr
; res = MprAdminInterfaceUpdateRoutes(hMprServer, hInterface, dwProtocolId, hEvent)
; hMprServer : INT_PTR -> "sptr"
; hInterface : HANDLE -> "sptr"
; dwProtocolId : DWORD -> "int"
; hEvent : HANDLE -> "sptr"
; DWORD MprAdminInterfaceUpdateRoutes(INT_PTR hMprServer, HANDLE hInterface, DWORD dwProtocolId, HANDLE hEvent)
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceUpdateRoutes "MprAdminInterfaceUpdateRoutes" intptr, intptr, int, intptr
; res = MprAdminInterfaceUpdateRoutes(hMprServer, hInterface, dwProtocolId, hEvent)
; hMprServer : INT_PTR -> "intptr"
; hInterface : HANDLE -> "intptr"
; dwProtocolId : DWORD -> "int"
; hEvent : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminInterfaceUpdateRoutes = mprapi.NewProc("MprAdminInterfaceUpdateRoutes")
)

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

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

typedef MprAdminInterfaceUpdateRoutesNative = Uint32 Function(IntPtr, Pointer<Void>, Uint32, Pointer<Void>);
typedef MprAdminInterfaceUpdateRoutesDart = int Function(int, Pointer<Void>, int, Pointer<Void>);
final MprAdminInterfaceUpdateRoutes = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminInterfaceUpdateRoutesNative, MprAdminInterfaceUpdateRoutesDart>('MprAdminInterfaceUpdateRoutes');
// hMprServer : INT_PTR -> IntPtr
// hInterface : HANDLE -> Pointer<Void>
// dwProtocolId : DWORD -> Uint32
// hEvent : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminInterfaceUpdateRoutes(
  hMprServer: NativeInt;   // INT_PTR
  hInterface: THandle;   // HANDLE
  dwProtocolId: DWORD;   // DWORD
  hEvent: THandle   // HANDLE
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminInterfaceUpdateRoutes';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminInterfaceUpdateRoutes"
  c_MprAdminInterfaceUpdateRoutes :: CIntPtr -> Ptr () -> Word32 -> Ptr () -> IO Word32
-- hMprServer : INT_PTR -> CIntPtr
-- hInterface : HANDLE -> Ptr ()
-- dwProtocolId : DWORD -> Word32
-- hEvent : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradmininterfaceupdateroutes =
  foreign "MprAdminInterfaceUpdateRoutes"
    (intptr_t @-> (ptr void) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hMprServer : INT_PTR -> intptr_t *)
(* hInterface : HANDLE -> (ptr void) *)
(* dwProtocolId : DWORD -> uint32_t *)
(* hEvent : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminInterfaceUpdateRoutes" mpr-admin-interface-update-routes :convention :stdcall) :uint32
  (h-mpr-server :int64)   ; INT_PTR
  (h-interface :pointer)   ; HANDLE
  (dw-protocol-id :uint32)   ; DWORD
  (h-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminInterfaceUpdateRoutes = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminInterfaceUpdateRoutes(LPARAM hMprServer, HANDLE hInterface, DWORD dwProtocolId, HANDLE hEvent)');
# my $ret = $MprAdminInterfaceUpdateRoutes->Call($hMprServer, $hInterface, $dwProtocolId, $hEvent);
# hMprServer : INT_PTR -> LPARAM
# hInterface : HANDLE -> HANDLE
# dwProtocolId : DWORD -> DWORD
# hEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。