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

WTSVirtualChannelOpenEx

関数
フラグ指定で仮想チャネルを開く。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

HANDLE WTSVirtualChannelOpenEx(
    DWORD SessionId,
    LPSTR pVirtualName,
    DWORD flags
);

パラメーター

名前方向説明
SessionIdDWORDin仮想チャネルを開く対象セッションのID。WTS_CURRENT_SESSIONも可。
pVirtualNameLPSTRin開く仮想チャネルの名前を指すANSI文字列。
flagsDWORDinチャネル種別を指定するフラグ(WTS_CHANNEL_OPTION_DYNAMIC等)。

戻り値の型: HANDLE

各言語での呼び出し定義

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

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

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

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSVirtualChannelOpenEx = Fiddle::Function.new(
  lib['WTSVirtualChannelOpenEx'],
  [
    -Fiddle::TYPE_INT,  # SessionId : DWORD
    Fiddle::TYPE_VOIDP,  # pVirtualName : LPSTR
    -Fiddle::TYPE_INT,  # flags : DWORD
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSVirtualChannelOpenEx(
        SessionId: u32,  // DWORD
        pVirtualName: *mut u8,  // LPSTR
        flags: u32  // DWORD
    ) -> *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 WTSVirtualChannelOpenEx(uint SessionId, [MarshalAs(UnmanagedType.LPStr)] string pVirtualName, uint flags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSVirtualChannelOpenEx' -Namespace Win32 -PassThru
# $api::WTSVirtualChannelOpenEx(SessionId, pVirtualName, flags)
#uselib "WTSAPI32.dll"
#func global WTSVirtualChannelOpenEx "WTSVirtualChannelOpenEx" sptr, sptr, sptr
; WTSVirtualChannelOpenEx SessionId, pVirtualName, flags   ; 戻り値は stat
; SessionId : DWORD -> "sptr"
; pVirtualName : LPSTR -> "sptr"
; flags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelOpenEx "WTSVirtualChannelOpenEx" int, str, int
; res = WTSVirtualChannelOpenEx(SessionId, pVirtualName, flags)
; SessionId : DWORD -> "int"
; pVirtualName : LPSTR -> "str"
; flags : DWORD -> "int"
; HANDLE WTSVirtualChannelOpenEx(DWORD SessionId, LPSTR pVirtualName, DWORD flags)
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelOpenEx "WTSVirtualChannelOpenEx" int, str, int
; res = WTSVirtualChannelOpenEx(SessionId, pVirtualName, flags)
; SessionId : DWORD -> "int"
; pVirtualName : LPSTR -> "str"
; flags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSVirtualChannelOpenEx = wtsapi32.NewProc("WTSVirtualChannelOpenEx")
)

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

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

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

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

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

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

関連項目

類似 API