ホーム › NetworkManagement.Rras › RtmGetEnumDests

RtmGetEnumDests

関数

宛先列挙から次の宛先情報の一群を取得する。

DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetEnumDests(
    INT_PTR RtmRegHandle,
    INT_PTR EnumHandle,
    DWORD* NumDests,
    RTM_DEST_INFO* DestInfos
);

パラメーター

名前	型	方向	説明
RtmRegHandle	INT_PTR	in	以前の RtmRegisterEntity の呼び出しで取得した、クライアントへのハンドル。
EnumHandle	INT_PTR	in	宛先の列挙へのハンドル。
NumDests	DWORD*	inout	入力時、NumDests は DestInfos が受け取ることのできる宛先の最大数を指定する UINT 値へのポインターです。出力時、NumDests は DestInfos が実際に受け取った宛先の数を受け取ります。
DestInfos	RTM_DEST_INFO*	inout	入力時、DestInfos は RTM_DEST_INFO 構造体へのポインターです。出力時、DestInfos は宛先へのハンドルの配列を受け取ります。

戻り値の型: DWORD

公式ドキュメント

RtmGetEnumDests 関数は、指定された列挙における次の宛先のセットを取得します。

戻り値

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

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

値	意味
ERROR_INVALID_PARAMETER	NumRoutes が指す値が、クライアントが 1 回の呼び出しで取得できるルートの最大数を超えています。クライアントが 1 回の呼び出しで取得できる宛先の最大数については、 RTM_REGN_PROFILE を確認してください。
ERROR_NO_MORE_ITEMS	列挙する宛先がこれ以上ありません。

解説(Remarks)

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

宛先が不要になったら、 RtmReleaseDests を呼び出して解放してください。

この関数を使用したサンプルコードについては、 Enumerate All Destinations を参照してください。

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

各言語での呼び出し定義

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

DWORD RtmGetEnumDests(
    INT_PTR RtmRegHandle,
    INT_PTR EnumHandle,
    DWORD* NumDests,
    RTM_DEST_INFO* DestInfos
);

[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint RtmGetEnumDests(
    IntPtr RtmRegHandle,   // INT_PTR
    IntPtr EnumHandle,   // INT_PTR
    ref uint NumDests,   // DWORD* in/out
    IntPtr DestInfos   // RTM_DEST_INFO* in/out
);

<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function RtmGetEnumDests(
    RtmRegHandle As IntPtr,   ' INT_PTR
    EnumHandle As IntPtr,   ' INT_PTR
    ByRef NumDests As UInteger,   ' DWORD* in/out
    DestInfos As IntPtr   ' RTM_DEST_INFO* in/out
) As UInteger
End Function

' RtmRegHandle : INT_PTR
' EnumHandle : INT_PTR
' NumDests : DWORD* in/out
' DestInfos : RTM_DEST_INFO* in/out
Declare PtrSafe Function RtmGetEnumDests Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByVal EnumHandle As LongPtr, _
    ByRef NumDests As Long, _
    ByVal DestInfos As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RtmGetEnumDests = ctypes.windll.rtm.RtmGetEnumDests
RtmGetEnumDests.restype = wintypes.DWORD
RtmGetEnumDests.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # EnumHandle : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # NumDests : DWORD* in/out
    ctypes.c_void_p,  # DestInfos : RTM_DEST_INFO* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtm.dll')
RtmGetEnumDests = Fiddle::Function.new(
  lib['RtmGetEnumDests'],
  [
    Fiddle::TYPE_INTPTR_T,  # RtmRegHandle : INT_PTR
    Fiddle::TYPE_INTPTR_T,  # EnumHandle : INT_PTR
    Fiddle::TYPE_VOIDP,  # NumDests : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # DestInfos : RTM_DEST_INFO* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "rtm")]
extern "system" {
    fn RtmGetEnumDests(
        RtmRegHandle: isize,  // INT_PTR
        EnumHandle: isize,  // INT_PTR
        NumDests: *mut u32,  // DWORD* in/out
        DestInfos: *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 RtmGetEnumDests(IntPtr RtmRegHandle, IntPtr EnumHandle, ref uint NumDests, IntPtr DestInfos);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtm_RtmGetEnumDests' -Namespace Win32 -PassThru
# $api::RtmGetEnumDests(RtmRegHandle, EnumHandle, NumDests, DestInfos)

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

出力引数:

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