ホーム › NetworkManagement.Rras › RtmGetExactMatchDestination

RtmGetExactMatchDestination

関数

指定アドレスに完全一致する宛先を取得する。

DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetExactMatchDestination(
    INT_PTR RtmRegHandle,
    RTM_NET_ADDRESS* DestAddress,
    DWORD ProtocolId,
    DWORD TargetViews,
    RTM_DEST_INFO* DestInfo
);

パラメーター

名前	型	方向	説明
RtmRegHandle	INT_PTR	in	以前の RtmRegisterEntity の呼び出しで取得した、クライアントへのハンドル。
DestAddress	RTM_NET_ADDRESS*	inout	宛先ネットワークアドレスへのポインター。
ProtocolId	DWORD	in	プロトコル識別子を指定します。ProtocolID は検索条件には含まれません。ルーティングテーブルマネージャーは、この識別子を使用して、どの宛先情報およびルート情報を返すかを決定します。たとえば、クライアントが RIP のプロトコル識別子を指定した場合、RIP 以外のルートが宛先への最適なルートであっても、最適な RIP ルートが返されます。どのプロトコルが所有しているかに関係なくルートを返すには、RTM_BEST_PROTOCOL を指定します。呼び出し元のプロトコルにとって最適なルートを返すには、RTM_THIS_PROTOCOL を指定します。
TargetViews	DWORD	in	情報を返す対象のビューを指定します。クライアントが RTM_VIEW_MASK_ANY を指定した場合、すべてのビューから宛先情報が返されますが、ビュー固有の情報は返されません。
DestInfo	RTM_DEST_INFO*	inout	入力時、DestInfo は RTM_DEST_INFO 構造体へのポインターです。出力時、DestInfo には要求された宛先情報が格納されます。

戻り値の型: DWORD

公式ドキュメント

RtmGetExactMatchDestination 関数は、指定されたネットワークアドレスおよびサブネットマスクに完全に一致する宛先をルーティングテーブルから検索します。完全に一致する宛先が見つかった場合、その宛先の情報が返されます。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合、戻り値は次のいずれかのエラーコードです。

値	意味
ERROR_NOT_FOUND	指定された宛先が見つかりませんでした。

解説(Remarks)

DestInfo 構造体は可変サイズの構造体です。クライアントが TargetViews で複数のビューを指定した場合、ビューごとに DestInfo のサイズが大きくなります。この関数を呼び出す前に、割り当てるべき DestInfo 構造体のサイズを決定するには、 RTM_SIZE_OF_DEST_INFO マクロを使用します。RTM_SIZE_OF_DEST_INFO のパラメーターには、TargetViews に指定した値を使用します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD RtmGetExactMatchDestination(
    INT_PTR RtmRegHandle,
    RTM_NET_ADDRESS* DestAddress,
    DWORD ProtocolId,
    DWORD TargetViews,
    RTM_DEST_INFO* DestInfo
);

[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint RtmGetExactMatchDestination(
    IntPtr RtmRegHandle,   // INT_PTR
    IntPtr DestAddress,   // RTM_NET_ADDRESS* in/out
    uint ProtocolId,   // DWORD
    uint TargetViews,   // DWORD
    IntPtr DestInfo   // RTM_DEST_INFO* in/out
);

<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function RtmGetExactMatchDestination(
    RtmRegHandle As IntPtr,   ' INT_PTR
    DestAddress As IntPtr,   ' RTM_NET_ADDRESS* in/out
    ProtocolId As UInteger,   ' DWORD
    TargetViews As UInteger,   ' DWORD
    DestInfo As IntPtr   ' RTM_DEST_INFO* in/out
) As UInteger
End Function

' RtmRegHandle : INT_PTR
' DestAddress : RTM_NET_ADDRESS* in/out
' ProtocolId : DWORD
' TargetViews : DWORD
' DestInfo : RTM_DEST_INFO* in/out
Declare PtrSafe Function RtmGetExactMatchDestination Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByVal DestAddress As LongPtr, _
    ByVal ProtocolId As Long, _
    ByVal TargetViews As Long, _
    ByVal DestInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RtmGetExactMatchDestination = ctypes.windll.rtm.RtmGetExactMatchDestination
RtmGetExactMatchDestination.restype = wintypes.DWORD
RtmGetExactMatchDestination.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_void_p,  # DestAddress : RTM_NET_ADDRESS* in/out
    wintypes.DWORD,  # ProtocolId : DWORD
    wintypes.DWORD,  # TargetViews : DWORD
    ctypes.c_void_p,  # DestInfo : RTM_DEST_INFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtm.dll')
RtmGetExactMatchDestination = Fiddle::Function.new(
  lib['RtmGetExactMatchDestination'],
  [
    Fiddle::TYPE_INTPTR_T,  # RtmRegHandle : INT_PTR
    Fiddle::TYPE_VOIDP,  # DestAddress : RTM_NET_ADDRESS* in/out
    -Fiddle::TYPE_INT,  # ProtocolId : DWORD
    -Fiddle::TYPE_INT,  # TargetViews : DWORD
    Fiddle::TYPE_VOIDP,  # DestInfo : RTM_DEST_INFO* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "rtm")]
extern "system" {
    fn RtmGetExactMatchDestination(
        RtmRegHandle: isize,  // INT_PTR
        DestAddress: *mut RTM_NET_ADDRESS,  // RTM_NET_ADDRESS* in/out
        ProtocolId: u32,  // DWORD
        TargetViews: u32,  // DWORD
        DestInfo: *mut RTM_DEST_INFO  // RTM_DEST_INFO* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("rtm.dll")]
public static extern uint RtmGetExactMatchDestination(IntPtr RtmRegHandle, IntPtr DestAddress, uint ProtocolId, uint TargetViews, IntPtr DestInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtm_RtmGetExactMatchDestination' -Namespace Win32 -PassThru
# $api::RtmGetExactMatchDestination(RtmRegHandle, DestAddress, ProtocolId, TargetViews, DestInfo)

#uselib "rtm.dll"
#func global RtmGetExactMatchDestination "RtmGetExactMatchDestination" sptr, sptr, sptr, sptr, sptr
; RtmGetExactMatchDestination RtmRegHandle, varptr(DestAddress), ProtocolId, TargetViews, varptr(DestInfo)   ; 戻り値は stat
; RtmRegHandle : INT_PTR -> "sptr"
; DestAddress : RTM_NET_ADDRESS* in/out -> "sptr"
; ProtocolId : DWORD -> "sptr"
; TargetViews : DWORD -> "sptr"
; DestInfo : RTM_DEST_INFO* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "rtm.dll"
#cfunc global RtmGetExactMatchDestination "RtmGetExactMatchDestination" sptr, var, int, int, var
; res = RtmGetExactMatchDestination(RtmRegHandle, DestAddress, ProtocolId, TargetViews, DestInfo)
; RtmRegHandle : INT_PTR -> "sptr"
; DestAddress : RTM_NET_ADDRESS* in/out -> "var"
; ProtocolId : DWORD -> "int"
; TargetViews : DWORD -> "int"
; DestInfo : RTM_DEST_INFO* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "rtm.dll"
#cfunc global RtmGetExactMatchDestination "RtmGetExactMatchDestination" sptr, sptr, int, int, sptr
; res = RtmGetExactMatchDestination(RtmRegHandle, varptr(DestAddress), ProtocolId, TargetViews, varptr(DestInfo))
; RtmRegHandle : INT_PTR -> "sptr"
; DestAddress : RTM_NET_ADDRESS* in/out -> "sptr"
; ProtocolId : DWORD -> "int"
; TargetViews : DWORD -> "int"
; DestInfo : RTM_DEST_INFO* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。