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

WTSVirtualChannelWrite

関数
仮想チャネルへデータを書き込む。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL WTSVirtualChannelWrite(
    HANDLE hChannelHandle,
    LPSTR Buffer,
    DWORD Length,
    DWORD* pBytesWritten
);

パラメーター

名前方向説明
hChannelHandleHANDLEin書き込み対象の仮想チャネルハンドル。
BufferLPSTRin送信するデータを格納したバッファ(入力)。
LengthDWORDinBufferの送信データ長(バイト数)。
pBytesWrittenDWORD*out実際に書き込まれたバイト数を受け取るポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

WTSVirtualChannelWrite = ctypes.windll.wtsapi32.WTSVirtualChannelWrite
WTSVirtualChannelWrite.restype = wintypes.BOOL
WTSVirtualChannelWrite.argtypes = [
    wintypes.HANDLE,  # hChannelHandle : HANDLE
    wintypes.LPCSTR,  # Buffer : LPSTR
    wintypes.DWORD,  # Length : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pBytesWritten : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WTSAPI32.dll')
WTSVirtualChannelWrite = Fiddle::Function.new(
  lib['WTSVirtualChannelWrite'],
  [
    Fiddle::TYPE_VOIDP,  # hChannelHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # Buffer : LPSTR
    -Fiddle::TYPE_INT,  # Length : DWORD
    Fiddle::TYPE_VOIDP,  # pBytesWritten : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wtsapi32")]
extern "system" {
    fn WTSVirtualChannelWrite(
        hChannelHandle: *mut core::ffi::c_void,  // HANDLE
        Buffer: *mut u8,  // LPSTR
        Length: u32,  // DWORD
        pBytesWritten: *mut u32  // DWORD* 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 WTSVirtualChannelWrite(IntPtr hChannelHandle, [MarshalAs(UnmanagedType.LPStr)] string Buffer, uint Length, out uint pBytesWritten);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WTSAPI32_WTSVirtualChannelWrite' -Namespace Win32 -PassThru
# $api::WTSVirtualChannelWrite(hChannelHandle, Buffer, Length, pBytesWritten)
#uselib "WTSAPI32.dll"
#func global WTSVirtualChannelWrite "WTSVirtualChannelWrite" sptr, sptr, sptr, sptr
; WTSVirtualChannelWrite hChannelHandle, Buffer, Length, varptr(pBytesWritten)   ; 戻り値は stat
; hChannelHandle : HANDLE -> "sptr"
; Buffer : LPSTR -> "sptr"
; Length : DWORD -> "sptr"
; pBytesWritten : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelWrite "WTSVirtualChannelWrite" sptr, str, int, var
; res = WTSVirtualChannelWrite(hChannelHandle, Buffer, Length, pBytesWritten)
; hChannelHandle : HANDLE -> "sptr"
; Buffer : LPSTR -> "str"
; Length : DWORD -> "int"
; pBytesWritten : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WTSVirtualChannelWrite(HANDLE hChannelHandle, LPSTR Buffer, DWORD Length, DWORD* pBytesWritten)
#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelWrite "WTSVirtualChannelWrite" intptr, str, int, var
; res = WTSVirtualChannelWrite(hChannelHandle, Buffer, Length, pBytesWritten)
; hChannelHandle : HANDLE -> "intptr"
; Buffer : LPSTR -> "str"
; Length : DWORD -> "int"
; pBytesWritten : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSVirtualChannelWrite = wtsapi32.NewProc("WTSVirtualChannelWrite")
)

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

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

typedef WTSVirtualChannelWriteNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Uint32>);
typedef WTSVirtualChannelWriteDart = int Function(Pointer<Void>, Pointer<Utf8>, int, Pointer<Uint32>);
final WTSVirtualChannelWrite = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSVirtualChannelWriteNative, WTSVirtualChannelWriteDart>('WTSVirtualChannelWrite');
// hChannelHandle : HANDLE -> Pointer<Void>
// Buffer : LPSTR -> Pointer<Utf8>
// Length : DWORD -> Uint32
// pBytesWritten : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSVirtualChannelWrite(
  hChannelHandle: THandle;   // HANDLE
  Buffer: PAnsiChar;   // LPSTR
  Length: DWORD;   // DWORD
  pBytesWritten: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSVirtualChannelWrite';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WTSVirtualChannelWrite"
  c_WTSVirtualChannelWrite :: Ptr () -> CString -> Word32 -> Ptr Word32 -> IO CInt
-- hChannelHandle : HANDLE -> Ptr ()
-- Buffer : LPSTR -> CString
-- Length : DWORD -> Word32
-- pBytesWritten : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wtsvirtualchannelwrite =
  foreign "WTSVirtualChannelWrite"
    ((ptr void) @-> string @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hChannelHandle : HANDLE -> (ptr void) *)
(* Buffer : LPSTR -> string *)
(* Length : DWORD -> uint32_t *)
(* pBytesWritten : DWORD* 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 ("WTSVirtualChannelWrite" wtsvirtual-channel-write :convention :stdcall) :int32
  (h-channel-handle :pointer)   ; HANDLE
  (buffer :string)   ; LPSTR
  (length :uint32)   ; DWORD
  (p-bytes-written :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WTSVirtualChannelWrite = Win32::API::More->new('WTSAPI32',
    'BOOL WTSVirtualChannelWrite(HANDLE hChannelHandle, LPCSTR Buffer, DWORD Length, LPVOID pBytesWritten)');
# my $ret = $WTSVirtualChannelWrite->Call($hChannelHandle, $Buffer, $Length, $pBytesWritten);
# hChannelHandle : HANDLE -> HANDLE
# Buffer : LPSTR -> LPCSTR
# Length : DWORD -> DWORD
# pBytesWritten : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。