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

WTSConnectSessionW

関数
別のセッションを指定セッションへ接続する。
DLLWTSAPI32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// WTSAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL WTSConnectSessionW(
    DWORD LogonId,
    DWORD TargetLogonId,
    LPWSTR pPassword,
    BOOL bWait
);

パラメーター

名前方向説明
LogonIdDWORDin接続元(物理コンソール等)のセッションID。
TargetLogonIdDWORDin接続先となる対象セッションのセッションID。
pPasswordLPWSTRin対象セッションのユーザーパスワードを指すワイド文字列。
bWaitBOOLinTRUEで接続完了まで待機、FALSEで即座に戻る。

戻り値の型: BOOL

各言語での呼び出し定義

// WTSAPI32.dll  (Unicode / -W)
#include <windows.h>

BOOL WTSConnectSessionW(
    DWORD LogonId,
    DWORD TargetLogonId,
    LPWSTR pPassword,
    BOOL bWait
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool WTSConnectSessionW(
    uint LogonId,   // DWORD
    uint TargetLogonId,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string pPassword,   // LPWSTR
    bool bWait   // BOOL
);
<DllImport("WTSAPI32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSConnectSessionW(
    LogonId As UInteger,   ' DWORD
    TargetLogonId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pPassword As String,   ' LPWSTR
    bWait As Boolean   ' BOOL
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' LogonId : DWORD
' TargetLogonId : DWORD
' pPassword : LPWSTR
' bWait : BOOL
Declare PtrSafe Function WTSConnectSessionW Lib "wtsapi32" ( _
    ByVal LogonId As Long, _
    ByVal TargetLogonId As Long, _
    ByVal pPassword As LongPtr, _
    ByVal bWait As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSConnectSessionW = ctypes.windll.wtsapi32.WTSConnectSessionW
WTSConnectSessionW.restype = wintypes.BOOL
WTSConnectSessionW.argtypes = [
    wintypes.DWORD,  # LogonId : DWORD
    wintypes.DWORD,  # TargetLogonId : DWORD
    wintypes.LPCWSTR,  # pPassword : LPWSTR
    wintypes.BOOL,  # bWait : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSConnectSessionW = Fiddle::Function.new(
  lib['WTSConnectSessionW'],
  [
    -Fiddle::TYPE_INT,  # LogonId : DWORD
    -Fiddle::TYPE_INT,  # TargetLogonId : DWORD
    Fiddle::TYPE_VOIDP,  # pPassword : LPWSTR
    Fiddle::TYPE_INT,  # bWait : BOOL
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSConnectSessionW(
        LogonId: u32,  // DWORD
        TargetLogonId: u32,  // DWORD
        pPassword: *mut u16,  // LPWSTR
        bWait: i32  // BOOL
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WTSAPI32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool WTSConnectSessionW(uint LogonId, uint TargetLogonId, [MarshalAs(UnmanagedType.LPWStr)] string pPassword, bool bWait);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSConnectSessionW' -Namespace Win32 -PassThru
# $api::WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
#uselib "WTSAPI32.dll"
#func global WTSConnectSessionW "WTSConnectSessionW" wptr, wptr, wptr, wptr
; WTSConnectSessionW LogonId, TargetLogonId, pPassword, bWait   ; 戻り値は stat
; LogonId : DWORD -> "wptr"
; TargetLogonId : DWORD -> "wptr"
; pPassword : LPWSTR -> "wptr"
; bWait : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WTSAPI32.dll"
#cfunc global WTSConnectSessionW "WTSConnectSessionW" int, int, wstr, int
; res = WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
; LogonId : DWORD -> "int"
; TargetLogonId : DWORD -> "int"
; pPassword : LPWSTR -> "wstr"
; bWait : BOOL -> "int"
; BOOL WTSConnectSessionW(DWORD LogonId, DWORD TargetLogonId, LPWSTR pPassword, BOOL bWait)
#uselib "WTSAPI32.dll"
#cfunc global WTSConnectSessionW "WTSConnectSessionW" int, int, wstr, int
; res = WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
; LogonId : DWORD -> "int"
; TargetLogonId : DWORD -> "int"
; pPassword : LPWSTR -> "wstr"
; bWait : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSConnectSessionW = wtsapi32.NewProc("WTSConnectSessionW")
)

// LogonId (DWORD), TargetLogonId (DWORD), pPassword (LPWSTR), bWait (BOOL)
r1, _, err := procWTSConnectSessionW.Call(
	uintptr(LogonId),
	uintptr(TargetLogonId),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pPassword))),
	uintptr(bWait),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WTSConnectSessionW(
  LogonId: DWORD;   // DWORD
  TargetLogonId: DWORD;   // DWORD
  pPassword: PWideChar;   // LPWSTR
  bWait: BOOL   // BOOL
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSConnectSessionW';
result := DllCall("WTSAPI32\WTSConnectSessionW"
    , "UInt", LogonId   ; DWORD
    , "UInt", TargetLogonId   ; DWORD
    , "WStr", pPassword   ; LPWSTR
    , "Int", bWait   ; BOOL
    , "Int")   ; return: BOOL
●WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait) = DLL("WTSAPI32.dll", "bool WTSConnectSessionW(dword, dword, char*, bool)")
# 呼び出し: WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
# LogonId : DWORD -> "dword"
# TargetLogonId : DWORD -> "dword"
# pPassword : LPWSTR -> "char*"
# bWait : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "wtsapi32" fn WTSConnectSessionW(
    LogonId: u32, // DWORD
    TargetLogonId: u32, // DWORD
    pPassword: [*c]const u16, // LPWSTR
    bWait: i32 // BOOL
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc WTSConnectSessionW(
    LogonId: uint32,  # DWORD
    TargetLogonId: uint32,  # DWORD
    pPassword: WideCString,  # LPWSTR
    bWait: int32  # BOOL
): int32 {.importc: "WTSConnectSessionW", stdcall, dynlib: "WTSAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "wtsapi32");
extern(Windows)
int WTSConnectSessionW(
    uint LogonId,   // DWORD
    uint TargetLogonId,   // DWORD
    const(wchar)* pPassword,   // LPWSTR
    int bWait   // BOOL
);
ccall((:WTSConnectSessionW, "WTSAPI32.dll"), stdcall, Int32,
      (UInt32, UInt32, Cwstring, Int32),
      LogonId, TargetLogonId, pPassword, bWait)
# LogonId : DWORD -> UInt32
# TargetLogonId : DWORD -> UInt32
# pPassword : LPWSTR -> Cwstring
# bWait : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSConnectSessionW(
    uint32_t LogonId,
    uint32_t TargetLogonId,
    const uint16_t* pPassword,
    int32_t bWait);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
-- LogonId : DWORD
-- TargetLogonId : DWORD
-- pPassword : LPWSTR
-- bWait : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSConnectSessionW = lib.func('__stdcall', 'WTSConnectSessionW', 'int32_t', ['uint32_t', 'uint32_t', 'str16', 'int32_t']);
// WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
// LogonId : DWORD -> 'uint32_t'
// TargetLogonId : DWORD -> 'uint32_t'
// pPassword : LPWSTR -> 'str16'
// bWait : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSConnectSessionW: { parameters: ["u32", "u32", "buffer", "i32"], result: "i32" },
});
// lib.symbols.WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait)
// LogonId : DWORD -> "u32"
// TargetLogonId : DWORD -> "u32"
// pPassword : LPWSTR -> "buffer"
// bWait : BOOL -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSConnectSessionW(
    uint32_t LogonId,
    uint32_t TargetLogonId,
    const uint16_t* pPassword,
    int32_t bWait);
C, "WTSAPI32.dll");
// $ffi->WTSConnectSessionW(LogonId, TargetLogonId, pPassword, bWait);
// LogonId : DWORD
// TargetLogonId : DWORD
// pPassword : LPWSTR
// bWait : BOOL
// 構造体/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.UNICODE_OPTIONS);
    boolean WTSConnectSessionW(
        int LogonId,   // DWORD
        int TargetLogonId,   // DWORD
        WString pPassword,   // LPWSTR
        boolean bWait   // BOOL
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSConnectSessionW = WTSConnectSessionW(
    LogonId : UInt32,   # DWORD
    TargetLogonId : UInt32,   # DWORD
    pPassword : UInt16*,   # LPWSTR
    bWait : Int32   # BOOL
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WTSConnectSessionWNative = Int32 Function(Uint32, Uint32, Pointer<Utf16>, Int32);
typedef WTSConnectSessionWDart = int Function(int, int, Pointer<Utf16>, int);
final WTSConnectSessionW = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSConnectSessionWNative, WTSConnectSessionWDart>('WTSConnectSessionW');
// LogonId : DWORD -> Uint32
// TargetLogonId : DWORD -> Uint32
// pPassword : LPWSTR -> Pointer<Utf16>
// bWait : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSConnectSessionW(
  LogonId: DWORD;   // DWORD
  TargetLogonId: DWORD;   // DWORD
  pPassword: PWideChar;   // LPWSTR
  bWait: BOOL   // BOOL
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSConnectSessionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSConnectSessionW"
  c_WTSConnectSessionW :: Word32 -> Word32 -> CWString -> CInt -> IO CInt
-- LogonId : DWORD -> Word32
-- TargetLogonId : DWORD -> Word32
-- pPassword : LPWSTR -> CWString
-- bWait : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsconnectsessionw =
  foreign "WTSConnectSessionW"
    (uint32_t @-> uint32_t @-> (ptr uint16_t) @-> int32_t @-> returning int32_t)
(* LogonId : DWORD -> uint32_t *)
(* TargetLogonId : DWORD -> uint32_t *)
(* pPassword : LPWSTR -> (ptr uint16_t) *)
(* bWait : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSConnectSessionW" wtsconnect-session-w :convention :stdcall) :int32
  (logon-id :uint32)   ; DWORD
  (target-logon-id :uint32)   ; DWORD
  (p-password (:string :encoding :utf-16le))   ; LPWSTR
  (b-wait :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSConnectSessionW = Win32::API::More->new('WTSAPI32',
    'BOOL WTSConnectSessionW(DWORD LogonId, DWORD TargetLogonId, LPCWSTR pPassword, BOOL bWait)');
# my $ret = $WTSConnectSessionW->Call($LogonId, $TargetLogonId, $pPassword, $bWait);
# LogonId : DWORD -> DWORD
# TargetLogonId : DWORD -> DWORD
# pPassword : LPWSTR -> LPCWSTR
# bWait : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い