ホーム › NetworkManagement.Rras › RtmGetLessSpecificDestination

RtmGetLessSpecificDestination

関数

指定宛先より粗いプレフィックスの宛先を取得する。

DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetLessSpecificDestination(
    INT_PTR RtmRegHandle,
    INT_PTR DestHandle,
    DWORD ProtocolId,
    DWORD TargetViews,
    RTM_DEST_INFO* DestInfo
);

パラメーター

名前	型	方向	説明
RtmRegHandle	INT_PTR	in	クライアントのハンドル。以前の RtmRegisterEntity の呼び出しで取得したものです。
DestHandle	INT_PTR	in	宛先のハンドル。
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

公式ドキュメント

RtmGetLessSpecificDestination 関数は、指定された宛先プレフィックスに対して、次に一致度の高い (最長の) プレフィックスを持つ宛先をルーティングテーブルから検索します。要求された宛先情報が返されます。

戻り値

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

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

値	意味
ERROR_INVALID_PARAMETER	パラメーターに正しくない情報が含まれています。
ERROR_NOT_FOUND	次に一致度の高い宛先が見つかりません。

解説(Remarks)

DestInfo パラメーターは、可変サイズの RTM_DEST_INFO 構造体です。クライアントが TargetViews で複数のビューを指定した場合、DestInfo のサイズはビューごとに増加します。この関数を呼び出す前に、 RTM_SIZE_OF_DEST_INFO マクロを使用して、DestInfo 構造体に割り当てるメモリ量を判断してください。 RTM_SIZE_OF_DEST_INFO のパラメーターには、TargetViews に指定した値を使用します。

RtmGetLessSpecificDestination 関数は、 RtmGetMostSpecificDestination の呼び出しの後に使用し、宛先に対する次に一致度の高い一致を返します。この呼び出しは、 RtmGetLessSpecificDestination の以前の呼び出しの後に使用して、さらに 1 つ一致度の低い一致を返すこともできます。クライアントはこの関数を使用して、宛先のプレフィックスツリーを "上へたどる" ことができます。

この呼び出しは、 RtmGetDestInfo や RtmGetChangedDests など、 RTM_DEST_INFO 構造体を返す関数の呼び出しの後にも使用されます。

RtmGetLessSpecificDestination 関数は、既定のルートが存在する場合、そこに到達するまで一致を返し続けます。既定のルートが見つかった後は、 RtmGetLessSpecificDestination は ERROR_NOT_FOUND を返します。

RtmGetLessSpecificDestination 関数と RtmGetMostSpecificDestination 関数の一般的な用途の 1 つは、一致するすべての宛先を取得することです。

この関数を使用したサンプルコードについては、プレフィックスツリーを使用したルートの検索を参照してください。

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

各言語での呼び出し定義

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

DWORD RtmGetLessSpecificDestination(
    INT_PTR RtmRegHandle,
    INT_PTR DestHandle,
    DWORD ProtocolId,
    DWORD TargetViews,
    RTM_DEST_INFO* DestInfo
);

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

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

' RtmRegHandle : INT_PTR
' DestHandle : INT_PTR
' ProtocolId : DWORD
' TargetViews : DWORD
' DestInfo : RTM_DEST_INFO* in/out
Declare PtrSafe Function RtmGetLessSpecificDestination Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByVal DestHandle 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

RtmGetLessSpecificDestination = ctypes.windll.rtm.RtmGetLessSpecificDestination
RtmGetLessSpecificDestination.restype = wintypes.DWORD
RtmGetLessSpecificDestination.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # DestHandle : INT_PTR
    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')
RtmGetLessSpecificDestination = Fiddle::Function.new(
  lib['RtmGetLessSpecificDestination'],
  [
    Fiddle::TYPE_INTPTR_T,  # RtmRegHandle : INT_PTR
    Fiddle::TYPE_INTPTR_T,  # DestHandle : INT_PTR
    -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 RtmGetLessSpecificDestination(
        RtmRegHandle: isize,  // INT_PTR
        DestHandle: isize,  // INT_PTR
        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 RtmGetLessSpecificDestination(IntPtr RtmRegHandle, IntPtr DestHandle, uint ProtocolId, uint TargetViews, IntPtr DestInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtm_RtmGetLessSpecificDestination' -Namespace Win32 -PassThru
# $api::RtmGetLessSpecificDestination(RtmRegHandle, DestHandle, ProtocolId, TargetViews, DestInfo)

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

出力引数:

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