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

RtmGetRegisteredEntities

関数
RTMに登録されているエンティティの一覧を取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetRegisteredEntities(
    INT_PTR RtmRegHandle,
    DWORD* NumEntities,
    INT_PTR* EntityHandles,
    RTM_ENTITY_INFO* EntityInfos
);

パラメーター

名前方向
RtmRegHandleINT_PTRin
NumEntitiesDWORD*inout
EntityHandlesINT_PTR*inout
EntityInfosRTM_ENTITY_INFO*inout

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD RtmGetRegisteredEntities(
    INT_PTR RtmRegHandle,
    DWORD* NumEntities,
    INT_PTR* EntityHandles,
    RTM_ENTITY_INFO* EntityInfos
);
[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint RtmGetRegisteredEntities(
    IntPtr RtmRegHandle,   // INT_PTR
    ref uint NumEntities,   // DWORD* in/out
    ref IntPtr EntityHandles,   // INT_PTR* in/out
    IntPtr EntityInfos   // RTM_ENTITY_INFO* in/out
);
<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function RtmGetRegisteredEntities(
    RtmRegHandle As IntPtr,   ' INT_PTR
    ByRef NumEntities As UInteger,   ' DWORD* in/out
    ByRef EntityHandles As IntPtr,   ' INT_PTR* in/out
    EntityInfos As IntPtr   ' RTM_ENTITY_INFO* in/out
) As UInteger
End Function
' RtmRegHandle : INT_PTR
' NumEntities : DWORD* in/out
' EntityHandles : INT_PTR* in/out
' EntityInfos : RTM_ENTITY_INFO* in/out
Declare PtrSafe Function RtmGetRegisteredEntities Lib "rtm" ( _
    ByVal RtmRegHandle As LongPtr, _
    ByRef NumEntities As Long, _
    ByRef EntityHandles As LongPtr, _
    ByVal EntityInfos As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtmGetRegisteredEntities = ctypes.windll.rtm.RtmGetRegisteredEntities
RtmGetRegisteredEntities.restype = wintypes.DWORD
RtmGetRegisteredEntities.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.POINTER(wintypes.DWORD),  # NumEntities : DWORD* in/out
    ctypes.POINTER(ctypes.c_ssize_t),  # EntityHandles : INT_PTR* in/out
    ctypes.c_void_p,  # EntityInfos : RTM_ENTITY_INFO* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmGetRegisteredEntities = rtm.NewProc("RtmGetRegisteredEntities")
)

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