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

RtmGetChangeStatus

関数
指定した宛先に変更通知が保留中かどうかの状態を取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD RtmGetChangeStatus(
    INT_PTR RtmRegHandle,
    INT_PTR NotifyHandle,
    INT_PTR DestHandle,
    BOOL* ChangeStatus
);

パラメーター

名前方向説明
RtmRegHandleINT_PTRinRTMクライアント登録ハンドル。
NotifyHandleINT_PTRin対象の変更通知ハンドル。
DestHandleINT_PTRin状態を問い合わせる対象の宛先ハンドル。
ChangeStatusBOOL*inout当該宛先に未処理の変更があればTRUEを受け取るBOOLポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

RtmGetChangeStatus = ctypes.windll.rtm.RtmGetChangeStatus
RtmGetChangeStatus.restype = wintypes.DWORD
RtmGetChangeStatus.argtypes = [
    ctypes.c_ssize_t,  # RtmRegHandle : INT_PTR
    ctypes.c_ssize_t,  # NotifyHandle : INT_PTR
    ctypes.c_ssize_t,  # DestHandle : INT_PTR
    ctypes.c_void_p,  # ChangeStatus : BOOL* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procRtmGetChangeStatus = rtm.NewProc("RtmGetChangeStatus")
)

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

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

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

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

(cffi:defcfun ("RtmGetChangeStatus" rtm-get-change-status :convention :stdcall) :uint32
  (rtm-reg-handle :int64)   ; INT_PTR
  (notify-handle :int64)   ; INT_PTR
  (dest-handle :int64)   ; INT_PTR
  (change-status :pointer))   ; BOOL* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtmGetChangeStatus = Win32::API::More->new('rtm',
    'DWORD RtmGetChangeStatus(LPARAM RtmRegHandle, LPARAM NotifyHandle, LPARAM DestHandle, LPVOID ChangeStatus)');
# my $ret = $RtmGetChangeStatus->Call($RtmRegHandle, $NotifyHandle, $DestHandle, $ChangeStatus);
# RtmRegHandle : INT_PTR -> LPARAM
# NotifyHandle : INT_PTR -> LPARAM
# DestHandle : INT_PTR -> LPARAM
# ChangeStatus : BOOL* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。