Win32 API 日本語リファレンス
ホームSystem.RemoteDesktop › WTSWaitSystemEvent

WTSWaitSystemEvent

関数
指定したシステムイベントの発生を待機する。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL WTSWaitSystemEvent(
    HANDLE hServer,   // optional
    DWORD EventMask,
    DWORD* pEventFlags
);

パラメーター

名前方向説明
hServerHANDLEoptional対象RDサーバーのハンドル。ローカルにはWTS_CURRENT_SERVER_HANDLEを指定。
EventMaskDWORDin待機対象とするシステムイベントのビットマスク(WTS_EVENT_*)。
pEventFlagsDWORD*inout実際に発生したイベントを示すフラグを受け取るポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL WTSWaitSystemEvent(
    HANDLE hServer,   // optional
    DWORD EventMask,
    DWORD* pEventFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool WTSWaitSystemEvent(
    IntPtr hServer,   // HANDLE optional
    uint EventMask,   // DWORD
    ref uint pEventFlags   // DWORD* in/out
);
<DllImport("WTSAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSWaitSystemEvent(
    hServer As IntPtr,   ' HANDLE optional
    EventMask As UInteger,   ' DWORD
    ByRef pEventFlags As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hServer : HANDLE optional
' EventMask : DWORD
' pEventFlags : DWORD* in/out
Declare PtrSafe Function WTSWaitSystemEvent Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByVal EventMask As Long, _
    ByRef pEventFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSWaitSystemEvent = ctypes.windll.wtsapi32.WTSWaitSystemEvent
WTSWaitSystemEvent.restype = wintypes.BOOL
WTSWaitSystemEvent.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    wintypes.DWORD,  # EventMask : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pEventFlags : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSWaitSystemEvent = wtsapi32.NewProc("WTSWaitSystemEvent")
)

// hServer (HANDLE optional), EventMask (DWORD), pEventFlags (DWORD* in/out)
r1, _, err := procWTSWaitSystemEvent.Call(
	uintptr(hServer),
	uintptr(EventMask),
	uintptr(pEventFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSWaitSystemEvent(
  hServer: THandle;   // HANDLE optional
  EventMask: DWORD;   // DWORD
  pEventFlags: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSWaitSystemEvent';
result := DllCall("WTSAPI32\WTSWaitSystemEvent"
    , "Ptr", hServer   ; HANDLE optional
    , "UInt", EventMask   ; DWORD
    , "Ptr", pEventFlags   ; DWORD* in/out
    , "Int")   ; return: BOOL
●WTSWaitSystemEvent(hServer, EventMask, pEventFlags) = DLL("WTSAPI32.dll", "bool WTSWaitSystemEvent(void*, dword, void*)")
# 呼び出し: WTSWaitSystemEvent(hServer, EventMask, pEventFlags)
# hServer : HANDLE optional -> "void*"
# EventMask : DWORD -> "dword"
# pEventFlags : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wtsapi32" fn WTSWaitSystemEvent(
    hServer: ?*anyopaque, // HANDLE optional
    EventMask: u32, // DWORD
    pEventFlags: [*c]u32 // DWORD* in/out
) callconv(std.os.windows.WINAPI) i32;
proc WTSWaitSystemEvent(
    hServer: pointer,  # HANDLE optional
    EventMask: uint32,  # DWORD
    pEventFlags: ptr uint32  # DWORD* in/out
): int32 {.importc: "WTSWaitSystemEvent", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSWaitSystemEvent(
    void* hServer,   // HANDLE optional
    uint EventMask,   // DWORD
    uint* pEventFlags   // DWORD* in/out
);
ccall((:WTSWaitSystemEvent, "WTSAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt32}),
      hServer, EventMask, pEventFlags)
# hServer : HANDLE optional -> Ptr{Cvoid}
# EventMask : DWORD -> UInt32
# pEventFlags : DWORD* in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSWaitSystemEvent(
    void* hServer,
    uint32_t EventMask,
    uint32_t* pEventFlags);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSWaitSystemEvent(hServer, EventMask, pEventFlags)
-- hServer : HANDLE optional
-- EventMask : DWORD
-- pEventFlags : DWORD* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSWaitSystemEvent = lib.func('__stdcall', 'WTSWaitSystemEvent', 'int32_t', ['void *', 'uint32_t', 'uint32_t *']);
// WTSWaitSystemEvent(hServer, EventMask, pEventFlags)
// hServer : HANDLE optional -> 'void *'
// EventMask : DWORD -> 'uint32_t'
// pEventFlags : DWORD* in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSWaitSystemEvent: { parameters: ["pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WTSWaitSystemEvent(hServer, EventMask, pEventFlags)
// hServer : HANDLE optional -> "pointer"
// EventMask : DWORD -> "u32"
// pEventFlags : DWORD* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSWaitSystemEvent(
    void* hServer,
    uint32_t EventMask,
    uint32_t* pEventFlags);
C, "WTSAPI32.dll");
// $ffi->WTSWaitSystemEvent(hServer, EventMask, pEventFlags);
// hServer : HANDLE optional
// EventMask : DWORD
// pEventFlags : DWORD* 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 Wtsapi32 extends StdCallLibrary {
    Wtsapi32 INSTANCE = Native.load("wtsapi32", Wtsapi32.class);
    boolean WTSWaitSystemEvent(
        Pointer hServer,   // HANDLE optional
        int EventMask,   // DWORD
        IntByReference pEventFlags   // DWORD* in/out
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSWaitSystemEvent = WTSWaitSystemEvent(
    hServer : Void*,   # HANDLE optional
    EventMask : UInt32,   # DWORD
    pEventFlags : UInt32*   # DWORD* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSWaitSystemEventNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Uint32>);
typedef WTSWaitSystemEventDart = int Function(Pointer<Void>, int, Pointer<Uint32>);
final WTSWaitSystemEvent = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSWaitSystemEventNative, WTSWaitSystemEventDart>('WTSWaitSystemEvent');
// hServer : HANDLE optional -> Pointer<Void>
// EventMask : DWORD -> Uint32
// pEventFlags : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSWaitSystemEvent(
  hServer: THandle;   // HANDLE optional
  EventMask: DWORD;   // DWORD
  pEventFlags: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSWaitSystemEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSWaitSystemEvent"
  c_WTSWaitSystemEvent :: Ptr () -> Word32 -> Ptr Word32 -> IO CInt
-- hServer : HANDLE optional -> Ptr ()
-- EventMask : DWORD -> Word32
-- pEventFlags : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtswaitsystemevent =
  foreign "WTSWaitSystemEvent"
    ((ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hServer : HANDLE optional -> (ptr void) *)
(* EventMask : DWORD -> uint32_t *)
(* pEventFlags : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSWaitSystemEvent" wtswait-system-event :convention :stdcall) :int32
  (h-server :pointer)   ; HANDLE optional
  (event-mask :uint32)   ; DWORD
  (p-event-flags :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSWaitSystemEvent = Win32::API::More->new('WTSAPI32',
    'BOOL WTSWaitSystemEvent(HANDLE hServer, DWORD EventMask, LPVOID pEventFlags)');
# my $ret = $WTSWaitSystemEvent->Call($hServer, $EventMask, $pEventFlags);
# hServer : HANDLE optional -> HANDLE
# EventMask : DWORD -> DWORD
# pEventFlags : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。