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

WTSVirtualChannelOpen

関数
指定セッションの仮想チャネルを開く。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HANDLE WTSVirtualChannelOpen(
    HANDLE hServer,   // optional
    DWORD SessionId,
    LPSTR pVirtualName
);

パラメーター

名前方向説明
hServerHANDLEoptional対象RDサーバーのハンドル。現状WTS_CURRENT_SERVER_HANDLEのみ指定可。
SessionIdDWORDin仮想チャネルを開く対象セッションのID。WTS_CURRENT_SESSIONも可。
pVirtualNameLPSTRin開く仮想チャネルの名前を指すANSI文字列(最大7文字)。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE WTSVirtualChannelOpen(
    HANDLE hServer,   // optional
    DWORD SessionId,
    LPSTR pVirtualName
);
[DllImport("WTSAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr WTSVirtualChannelOpen(
    IntPtr hServer,   // HANDLE optional
    uint SessionId,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pVirtualName   // LPSTR
);
<DllImport("WTSAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WTSVirtualChannelOpen(
    hServer As IntPtr,   ' HANDLE optional
    SessionId As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pVirtualName As String   ' LPSTR
) As IntPtr
End Function
' hServer : HANDLE optional
' SessionId : DWORD
' pVirtualName : LPSTR
Declare PtrSafe Function WTSVirtualChannelOpen Lib "wtsapi32" ( _
    ByVal hServer As LongPtr, _
    ByVal SessionId As Long, _
    ByVal pVirtualName As String) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WTSVirtualChannelOpen = ctypes.windll.wtsapi32.WTSVirtualChannelOpen
WTSVirtualChannelOpen.restype = ctypes.c_void_p
WTSVirtualChannelOpen.argtypes = [
    wintypes.HANDLE,  # hServer : HANDLE optional
    wintypes.DWORD,  # SessionId : DWORD
    wintypes.LPCSTR,  # pVirtualName : LPSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSVirtualChannelOpen = Fiddle::Function.new(
  lib['WTSVirtualChannelOpen'],
  [
    Fiddle::TYPE_VOIDP,  # hServer : HANDLE optional
    -Fiddle::TYPE_INT,  # SessionId : DWORD
    Fiddle::TYPE_VOIDP,  # pVirtualName : LPSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSVirtualChannelOpen(
        hServer: *mut core::ffi::c_void,  // HANDLE optional
        SessionId: u32,  // DWORD
        pVirtualName: *mut u8  // LPSTR
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WTSAPI32.dll", SetLastError = true)]
public static extern IntPtr WTSVirtualChannelOpen(IntPtr hServer, uint SessionId, [MarshalAs(UnmanagedType.LPStr)] string pVirtualName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSVirtualChannelOpen' -Namespace Win32 -PassThru
# $api::WTSVirtualChannelOpen(hServer, SessionId, pVirtualName)
#uselib "WTSAPI32.dll"
#func global WTSVirtualChannelOpen "WTSVirtualChannelOpen" sptr, sptr, sptr
; WTSVirtualChannelOpen hServer, SessionId, pVirtualName   ; 戻り値は stat
; hServer : HANDLE optional -> "sptr"
; SessionId : DWORD -> "sptr"
; pVirtualName : LPSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelOpen "WTSVirtualChannelOpen" sptr, int, str
; res = WTSVirtualChannelOpen(hServer, SessionId, pVirtualName)
; hServer : HANDLE optional -> "sptr"
; SessionId : DWORD -> "int"
; pVirtualName : LPSTR -> "str"
; HANDLE WTSVirtualChannelOpen(HANDLE hServer, DWORD SessionId, LPSTR pVirtualName)
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelOpen "WTSVirtualChannelOpen" intptr, int, str
; res = WTSVirtualChannelOpen(hServer, SessionId, pVirtualName)
; hServer : HANDLE optional -> "intptr"
; SessionId : DWORD -> "int"
; pVirtualName : LPSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSVirtualChannelOpen = wtsapi32.NewProc("WTSVirtualChannelOpen")
)

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

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

typedef WTSVirtualChannelOpenNative = Pointer<Void> Function(Pointer<Void>, Uint32, Pointer<Utf8>);
typedef WTSVirtualChannelOpenDart = Pointer<Void> Function(Pointer<Void>, int, Pointer<Utf8>);
final WTSVirtualChannelOpen = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSVirtualChannelOpenNative, WTSVirtualChannelOpenDart>('WTSVirtualChannelOpen');
// hServer : HANDLE optional -> Pointer<Void>
// SessionId : DWORD -> Uint32
// pVirtualName : LPSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSVirtualChannelOpen(
  hServer: THandle;   // HANDLE optional
  SessionId: DWORD;   // DWORD
  pVirtualName: PAnsiChar   // LPSTR
): THandle; stdcall;
  external 'WTSAPI32.dll' name 'WTSVirtualChannelOpen';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSVirtualChannelOpen"
  c_WTSVirtualChannelOpen :: Ptr () -> Word32 -> CString -> IO (Ptr ())
-- hServer : HANDLE optional -> Ptr ()
-- SessionId : DWORD -> Word32
-- pVirtualName : LPSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsvirtualchannelopen =
  foreign "WTSVirtualChannelOpen"
    ((ptr void) @-> uint32_t @-> string @-> returning (ptr void))
(* hServer : HANDLE optional -> (ptr void) *)
(* SessionId : DWORD -> uint32_t *)
(* pVirtualName : LPSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wtsapi32 (t "WTSAPI32.dll"))
(cffi:use-foreign-library wtsapi32)

(cffi:defcfun ("WTSVirtualChannelOpen" wtsvirtual-channel-open :convention :stdcall) :pointer
  (h-server :pointer)   ; HANDLE optional
  (session-id :uint32)   ; DWORD
  (p-virtual-name :string))   ; LPSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSVirtualChannelOpen = Win32::API::More->new('WTSAPI32',
    'HANDLE WTSVirtualChannelOpen(HANDLE hServer, DWORD SessionId, LPCSTR pVirtualName)');
# my $ret = $WTSVirtualChannelOpen->Call($hServer, $SessionId, $pVirtualName);
# hServer : HANDLE optional -> HANDLE
# SessionId : DWORD -> DWORD
# pVirtualName : LPSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API