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

RtmLockNextHop

関数
指定したネクストホップをロックし情報ポインタを取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmLockNextHop(
    INT_PTR RtmRegHandle,
    INT_PTR NextHopHandle,
    BOOL Exclusive,
    BOOL LockNextHop,
    RTM_NEXTHOP_INFO** NextHopPointer
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRtmRegisterEntityで取得したRTM登録ハンドル。
NextHopHandleINT_PTRinロック/アンロックする対象ネクストホップのハンドル。
ExclusiveBOOLinTRUEなら排他(書き込み)ロック、FALSEなら共有(読み取り)ロックを取得する。
LockNextHopBOOLinTRUEならロックを取得し、FALSEならロックを解放する。
NextHopPointerRTM_NEXTHOP_INFO**inoutロック中にアクセスできるネクストホップ情報への直接ポインタを受け取る。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RtmLockNextHop(
    INT_PTR RtmRegHandle,
    INT_PTR NextHopHandle,
    BOOL Exclusive,
    BOOL LockNextHop,
    RTM_NEXTHOP_INFO** NextHopPointer
);
[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint RtmLockNextHop(
    IntPtr RtmRegHandle,   // INT_PTR
    IntPtr NextHopHandle,   // INT_PTR
    bool Exclusive,   // BOOL
    bool LockNextHop,   // BOOL
    IntPtr NextHopPointer   // RTM_NEXTHOP_INFO** in/out
);
<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function RtmLockNextHop(
    RtmRegHandle As IntPtr,   ' INT_PTR
    NextHopHandle As IntPtr,   ' INT_PTR
    Exclusive As Boolean,   ' BOOL
    LockNextHop As Boolean,   ' BOOL
    NextHopPointer As IntPtr   ' RTM_NEXTHOP_INFO** in/out
) As UInteger
End Function
' RtmRegHandle : INT_PTR
' NextHopHandle : INT_PTR
' Exclusive : BOOL
' LockNextHop : BOOL
' NextHopPointer : RTM_NEXTHOP_INFO** in/out
Declare PtrSafe Function RtmLockNextHop Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByVal NextHopHandle As LongPtr, _
    ByVal Exclusive As Long, _
    ByVal LockNextHop As Long, _
    ByVal NextHopPointer As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtmLockNextHop = ctypes.windll.rtm.RtmLockNextHop
RtmLockNextHop.restype = wintypes.DWORD
RtmLockNextHop.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # NextHopHandle : INT_PTR
    wintypes.BOOL,  # Exclusive : BOOL
    wintypes.BOOL,  # LockNextHop : BOOL
    ctypes.c_void_p,  # NextHopPointer : RTM_NEXTHOP_INFO** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmLockNextHop = rtm.NewProc("RtmLockNextHop")
)

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

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

foreign import stdcall safe "RtmLockNextHop"
  c_RtmLockNextHop :: CIntPtr -> CIntPtr -> CInt -> CInt -> Ptr () -> IO Word32
-- RtmRegHandle : INT_PTR -> CIntPtr
-- NextHopHandle : INT_PTR -> CIntPtr
-- Exclusive : BOOL -> CInt
-- LockNextHop : BOOL -> CInt
-- NextHopPointer : RTM_NEXTHOP_INFO** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtmlocknexthop =
  foreign "RtmLockNextHop"
    (intptr_t @-> intptr_t @-> int32_t @-> int32_t @-> (ptr void) @-> returning uint32_t)
(* RtmRegHandle : INT_PTR -> intptr_t *)
(* NextHopHandle : INT_PTR -> intptr_t *)
(* Exclusive : BOOL -> int32_t *)
(* LockNextHop : BOOL -> int32_t *)
(* NextHopPointer : RTM_NEXTHOP_INFO** in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("RtmLockNextHop" rtm-lock-next-hop :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (next-hop-handle :int64)   ; INT_PTR
  (exclusive :int32)   ; BOOL
  (lock-next-hop :int32)   ; BOOL
  (next-hop-pointer :pointer))   ; RTM_NEXTHOP_INFO** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmLockNextHop = Win32::API::More->new('rtm',
    'DWORD RtmLockNextHop(LPARAM RtmRegHandle, LPARAM NextHopHandle, BOOL Exclusive, BOOL LockNextHop, LPVOID NextHopPointer)');
# my $ret = $RtmLockNextHop->Call($RtmRegHandle, $NextHopHandle, $Exclusive, $LockNextHop, $NextHopPointer);
# RtmRegHandle : INT_PTR -> LPARAM
# NextHopHandle : INT_PTR -> LPARAM
# Exclusive : BOOL -> BOOL
# LockNextHop : BOOL -> BOOL
# NextHopPointer : RTM_NEXTHOP_INFO** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型