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

WTSStartRemoteControlSessionA

関数
指定セッションのリモート制御セッションを開始する。
DLLWTSAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSStartRemoteControlSessionA(
    LPSTR pTargetServerName,
    DWORD TargetLogonId,
    BYTE HotkeyVk,
    WORD HotkeyModifiers
);

パラメーター

名前方向説明
pTargetServerNameLPSTRin制御対象セッションをホストするRDサーバー名を指すANSI文字列。
TargetLogonIdDWORDinリモート制御を開始する対象セッションのセッションID。
HotkeyVkBYTEin制御を終了するホットキーの仮想キーコード(BYTE)。
HotkeyModifiersWORDinホットキーの修飾キーフラグ(Shift/Ctrl/Alt等)。

戻り値の型: BOOL

各言語での呼び出し定義

// WTSAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL WTSStartRemoteControlSessionA(
    LPSTR pTargetServerName,
    DWORD TargetLogonId,
    BYTE HotkeyVk,
    WORD HotkeyModifiers
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool WTSStartRemoteControlSessionA(
    [MarshalAs(UnmanagedType.LPStr)] string pTargetServerName,   // LPSTR
    uint TargetLogonId,   // DWORD
    byte HotkeyVk,   // BYTE
    ushort HotkeyModifiers   // WORD
);
<DllImport("WTSAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSStartRemoteControlSessionA(
    <MarshalAs(UnmanagedType.LPStr)> pTargetServerName As String,   ' LPSTR
    TargetLogonId As UInteger,   ' DWORD
    HotkeyVk As Byte,   ' BYTE
    HotkeyModifiers As UShort   ' WORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pTargetServerName : LPSTR
' TargetLogonId : DWORD
' HotkeyVk : BYTE
' HotkeyModifiers : WORD
Declare PtrSafe Function WTSStartRemoteControlSessionA Lib "wtsapi32" ( _
    ByVal pTargetServerName As String, _
    ByVal TargetLogonId As Long, _
    ByVal HotkeyVk As Byte, _
    ByVal HotkeyModifiers As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSStartRemoteControlSessionA = ctypes.windll.wtsapi32.WTSStartRemoteControlSessionA
WTSStartRemoteControlSessionA.restype = wintypes.BOOL
WTSStartRemoteControlSessionA.argtypes = [
    wintypes.LPCSTR,  # pTargetServerName : LPSTR
    wintypes.DWORD,  # TargetLogonId : DWORD
    ctypes.c_ubyte,  # HotkeyVk : BYTE
    ctypes.c_ushort,  # HotkeyModifiers : WORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSStartRemoteControlSessionA = Fiddle::Function.new(
  lib['WTSStartRemoteControlSessionA'],
  [
    Fiddle::TYPE_VOIDP,  # pTargetServerName : LPSTR
    -Fiddle::TYPE_INT,  # TargetLogonId : DWORD
    -Fiddle::TYPE_CHAR,  # HotkeyVk : BYTE
    -Fiddle::TYPE_SHORT,  # HotkeyModifiers : WORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSStartRemoteControlSessionA(
        pTargetServerName: *mut u8,  // LPSTR
        TargetLogonId: u32,  // DWORD
        HotkeyVk: u8,  // BYTE
        HotkeyModifiers: u16  // WORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool WTSStartRemoteControlSessionA([MarshalAs(UnmanagedType.LPStr)] string pTargetServerName, uint TargetLogonId, byte HotkeyVk, ushort HotkeyModifiers);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSStartRemoteControlSessionA' -Namespace Win32 -PassThru
# $api::WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
#uselib "WTSAPI32.dll"
#func global WTSStartRemoteControlSessionA "WTSStartRemoteControlSessionA" sptr, sptr, sptr, sptr
; WTSStartRemoteControlSessionA pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers   ; 戻り値は stat
; pTargetServerName : LPSTR -> "sptr"
; TargetLogonId : DWORD -> "sptr"
; HotkeyVk : BYTE -> "sptr"
; HotkeyModifiers : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WTSAPI32.dll"
#cfunc global WTSStartRemoteControlSessionA "WTSStartRemoteControlSessionA" str, int, int, int
; res = WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
; pTargetServerName : LPSTR -> "str"
; TargetLogonId : DWORD -> "int"
; HotkeyVk : BYTE -> "int"
; HotkeyModifiers : WORD -> "int"
; BOOL WTSStartRemoteControlSessionA(LPSTR pTargetServerName, DWORD TargetLogonId, BYTE HotkeyVk, WORD HotkeyModifiers)
#uselib "WTSAPI32.dll"
#cfunc global WTSStartRemoteControlSessionA "WTSStartRemoteControlSessionA" str, int, int, int
; res = WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
; pTargetServerName : LPSTR -> "str"
; TargetLogonId : DWORD -> "int"
; HotkeyVk : BYTE -> "int"
; HotkeyModifiers : WORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSStartRemoteControlSessionA = wtsapi32.NewProc("WTSStartRemoteControlSessionA")
)

// pTargetServerName (LPSTR), TargetLogonId (DWORD), HotkeyVk (BYTE), HotkeyModifiers (WORD)
r1, _, err := procWTSStartRemoteControlSessionA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pTargetServerName))),
	uintptr(TargetLogonId),
	uintptr(HotkeyVk),
	uintptr(HotkeyModifiers),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSStartRemoteControlSessionA(
  pTargetServerName: PAnsiChar;   // LPSTR
  TargetLogonId: DWORD;   // DWORD
  HotkeyVk: Byte;   // BYTE
  HotkeyModifiers: Word   // WORD
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSStartRemoteControlSessionA';
result := DllCall("WTSAPI32\WTSStartRemoteControlSessionA"
    , "AStr", pTargetServerName   ; LPSTR
    , "UInt", TargetLogonId   ; DWORD
    , "UChar", HotkeyVk   ; BYTE
    , "UShort", HotkeyModifiers   ; WORD
    , "Int")   ; return: BOOL
●WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers) = DLL("WTSAPI32.dll", "bool WTSStartRemoteControlSessionA(char*, dword, byte, int)")
# 呼び出し: WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
# pTargetServerName : LPSTR -> "char*"
# TargetLogonId : DWORD -> "dword"
# HotkeyVk : BYTE -> "byte"
# HotkeyModifiers : WORD -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wtsapi32" fn WTSStartRemoteControlSessionA(
    pTargetServerName: [*c]const u8, // LPSTR
    TargetLogonId: u32, // DWORD
    HotkeyVk: u8, // BYTE
    HotkeyModifiers: u16 // WORD
) callconv(std.os.windows.WINAPI) i32;
proc WTSStartRemoteControlSessionA(
    pTargetServerName: cstring,  # LPSTR
    TargetLogonId: uint32,  # DWORD
    HotkeyVk: uint8,  # BYTE
    HotkeyModifiers: uint16  # WORD
): int32 {.importc: "WTSStartRemoteControlSessionA", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSStartRemoteControlSessionA(
    const(char)* pTargetServerName,   // LPSTR
    uint TargetLogonId,   // DWORD
    ubyte HotkeyVk,   // BYTE
    ushort HotkeyModifiers   // WORD
);
ccall((:WTSStartRemoteControlSessionA, "WTSAPI32.dll"), stdcall, Int32,
      (Cstring, UInt32, UInt8, UInt16),
      pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
# pTargetServerName : LPSTR -> Cstring
# TargetLogonId : DWORD -> UInt32
# HotkeyVk : BYTE -> UInt8
# HotkeyModifiers : WORD -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSStartRemoteControlSessionA(
    const char* pTargetServerName,
    uint32_t TargetLogonId,
    uint8_t HotkeyVk,
    uint16_t HotkeyModifiers);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
-- pTargetServerName : LPSTR
-- TargetLogonId : DWORD
-- HotkeyVk : BYTE
-- HotkeyModifiers : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSStartRemoteControlSessionA = lib.func('__stdcall', 'WTSStartRemoteControlSessionA', 'int32_t', ['str', 'uint32_t', 'uint8_t', 'uint16_t']);
// WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
// pTargetServerName : LPSTR -> 'str'
// TargetLogonId : DWORD -> 'uint32_t'
// HotkeyVk : BYTE -> 'uint8_t'
// HotkeyModifiers : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSStartRemoteControlSessionA: { parameters: ["buffer", "u32", "u8", "u16"], result: "i32" },
});
// lib.symbols.WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers)
// pTargetServerName : LPSTR -> "buffer"
// TargetLogonId : DWORD -> "u32"
// HotkeyVk : BYTE -> "u8"
// HotkeyModifiers : WORD -> "u16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSStartRemoteControlSessionA(
    const char* pTargetServerName,
    uint32_t TargetLogonId,
    uint8_t HotkeyVk,
    uint16_t HotkeyModifiers);
C, "WTSAPI32.dll");
// $ffi->WTSStartRemoteControlSessionA(pTargetServerName, TargetLogonId, HotkeyVk, HotkeyModifiers);
// pTargetServerName : LPSTR
// TargetLogonId : DWORD
// HotkeyVk : BYTE
// HotkeyModifiers : WORD
// 構造体/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, W32APIOptions.ASCII_OPTIONS);
    boolean WTSStartRemoteControlSessionA(
        String pTargetServerName,   // LPSTR
        int TargetLogonId,   // DWORD
        byte HotkeyVk,   // BYTE
        short HotkeyModifiers   // WORD
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSStartRemoteControlSessionA = WTSStartRemoteControlSessionA(
    pTargetServerName : UInt8*,   # LPSTR
    TargetLogonId : UInt32,   # DWORD
    HotkeyVk : UInt8,   # BYTE
    HotkeyModifiers : UInt16   # WORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSStartRemoteControlSessionANative = Int32 Function(Pointer<Utf8>, Uint32, Uint8, Uint16);
typedef WTSStartRemoteControlSessionADart = int Function(Pointer<Utf8>, int, int, int);
final WTSStartRemoteControlSessionA = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSStartRemoteControlSessionANative, WTSStartRemoteControlSessionADart>('WTSStartRemoteControlSessionA');
// pTargetServerName : LPSTR -> Pointer<Utf8>
// TargetLogonId : DWORD -> Uint32
// HotkeyVk : BYTE -> Uint8
// HotkeyModifiers : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSStartRemoteControlSessionA(
  pTargetServerName: PAnsiChar;   // LPSTR
  TargetLogonId: DWORD;   // DWORD
  HotkeyVk: Byte;   // BYTE
  HotkeyModifiers: Word   // WORD
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSStartRemoteControlSessionA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSStartRemoteControlSessionA"
  c_WTSStartRemoteControlSessionA :: CString -> Word32 -> Word8 -> Word16 -> IO CInt
-- pTargetServerName : LPSTR -> CString
-- TargetLogonId : DWORD -> Word32
-- HotkeyVk : BYTE -> Word8
-- HotkeyModifiers : WORD -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsstartremotecontrolsessiona =
  foreign "WTSStartRemoteControlSessionA"
    (string @-> uint32_t @-> uint8_t @-> uint16_t @-> returning int32_t)
(* pTargetServerName : LPSTR -> string *)
(* TargetLogonId : DWORD -> uint32_t *)
(* HotkeyVk : BYTE -> uint8_t *)
(* HotkeyModifiers : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSStartRemoteControlSessionA" wtsstart-remote-control-session-a :convention :stdcall) :int32
  (p-target-server-name :string)   ; LPSTR
  (target-logon-id :uint32)   ; DWORD
  (hotkey-vk :uint8)   ; BYTE
  (hotkey-modifiers :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSStartRemoteControlSessionA = Win32::API::More->new('WTSAPI32',
    'BOOL WTSStartRemoteControlSessionA(LPCSTR pTargetServerName, DWORD TargetLogonId, BYTE HotkeyVk, WORD HotkeyModifiers)');
# my $ret = $WTSStartRemoteControlSessionA->Call($pTargetServerName, $TargetLogonId, $HotkeyVk, $HotkeyModifiers);
# pTargetServerName : LPSTR -> LPCSTR
# TargetLogonId : DWORD -> DWORD
# HotkeyVk : BYTE -> BYTE
# HotkeyModifiers : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い