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

WTSVirtualChannelRead

関数
仮想チャネルからデータを読み取る。
DLLWTSAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL WTSVirtualChannelRead(
    HANDLE hChannelHandle,
    DWORD TimeOut,
    LPSTR Buffer,
    DWORD BufferSize,
    DWORD* pBytesRead
);

パラメーター

名前方向説明
hChannelHandleHANDLEin読み取り対象の仮想チャネルハンドル。
TimeOutDWORDin読み取りを待つタイムアウト時間(ミリ秒)。
BufferLPSTRout受信データを格納するバッファ(出力)。
BufferSizeDWORDinBufferのサイズ(バイト数)。
pBytesReadDWORD*out実際に読み取られたバイト数を受け取るポインタ(出力)。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

var (
	wtsapi32 = windows.NewLazySystemDLL("WTSAPI32.dll")
	procWTSVirtualChannelRead = wtsapi32.NewProc("WTSVirtualChannelRead")
)

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

extern "wtsapi32" fn WTSVirtualChannelRead(
    hChannelHandle: ?*anyopaque, // HANDLE
    TimeOut: u32, // DWORD
    Buffer: [*c]u8, // LPSTR out
    BufferSize: u32, // DWORD
    pBytesRead: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WTSVirtualChannelRead(
    hChannelHandle: pointer,  # HANDLE
    TimeOut: uint32,  # DWORD
    Buffer: ptr char,  # LPSTR out
    BufferSize: uint32,  # DWORD
    pBytesRead: ptr uint32  # DWORD* out
): int32 {.importc: "WTSVirtualChannelRead", stdcall, dynlib: "WTSAPI32.dll".}
pragma(lib, "wtsapi32");
extern(Windows)
int WTSVirtualChannelRead(
    void* hChannelHandle,   // HANDLE
    uint TimeOut,   // DWORD
    char* Buffer,   // LPSTR out
    uint BufferSize,   // DWORD
    uint* pBytesRead   // DWORD* out
);
ccall((:WTSVirtualChannelRead, "WTSAPI32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}),
      hChannelHandle, TimeOut, Buffer, BufferSize, pBytesRead)
# hChannelHandle : HANDLE -> Ptr{Cvoid}
# TimeOut : DWORD -> UInt32
# Buffer : LPSTR out -> Ptr{UInt8}
# BufferSize : DWORD -> UInt32
# pBytesRead : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WTSVirtualChannelRead(
    void* hChannelHandle,
    uint32_t TimeOut,
    char* Buffer,
    uint32_t BufferSize,
    uint32_t* pBytesRead);
]]
local wtsapi32 = ffi.load("wtsapi32")
-- wtsapi32.WTSVirtualChannelRead(hChannelHandle, TimeOut, Buffer, BufferSize, pBytesRead)
-- hChannelHandle : HANDLE
-- TimeOut : DWORD
-- Buffer : LPSTR out
-- BufferSize : DWORD
-- pBytesRead : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WTSAPI32.dll');
const WTSVirtualChannelRead = lib.func('__stdcall', 'WTSVirtualChannelRead', 'int32_t', ['void *', 'uint32_t', 'char *', 'uint32_t', 'uint32_t *']);
// WTSVirtualChannelRead(hChannelHandle, TimeOut, Buffer, BufferSize, pBytesRead)
// hChannelHandle : HANDLE -> 'void *'
// TimeOut : DWORD -> 'uint32_t'
// Buffer : LPSTR out -> 'char *'
// BufferSize : DWORD -> 'uint32_t'
// pBytesRead : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WTSAPI32.dll", {
  WTSVirtualChannelRead: { parameters: ["pointer", "u32", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.WTSVirtualChannelRead(hChannelHandle, TimeOut, Buffer, BufferSize, pBytesRead)
// hChannelHandle : HANDLE -> "pointer"
// TimeOut : DWORD -> "u32"
// Buffer : LPSTR out -> "buffer"
// BufferSize : DWORD -> "u32"
// pBytesRead : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WTSVirtualChannelRead(
    void* hChannelHandle,
    uint32_t TimeOut,
    char* Buffer,
    uint32_t BufferSize,
    uint32_t* pBytesRead);
C, "WTSAPI32.dll");
// $ffi->WTSVirtualChannelRead(hChannelHandle, TimeOut, Buffer, BufferSize, pBytesRead);
// hChannelHandle : HANDLE
// TimeOut : DWORD
// Buffer : LPSTR out
// BufferSize : DWORD
// pBytesRead : 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 WTSVirtualChannelRead(
        Pointer hChannelHandle,   // HANDLE
        int TimeOut,   // DWORD
        byte[] Buffer,   // LPSTR out
        int BufferSize,   // DWORD
        IntByReference pBytesRead   // DWORD* out
    );
}
@[Link("wtsapi32")]
lib LibWTSAPI32
  fun WTSVirtualChannelRead = WTSVirtualChannelRead(
    hChannelHandle : Void*,   # HANDLE
    TimeOut : UInt32,   # DWORD
    Buffer : UInt8*,   # LPSTR out
    BufferSize : UInt32,   # DWORD
    pBytesRead : 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 WTSVirtualChannelReadNative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf8>, Uint32, Pointer<Uint32>);
typedef WTSVirtualChannelReadDart = int Function(Pointer<Void>, int, Pointer<Utf8>, int, Pointer<Uint32>);
final WTSVirtualChannelRead = DynamicLibrary.open('WTSAPI32.dll')
    .lookupFunction<WTSVirtualChannelReadNative, WTSVirtualChannelReadDart>('WTSVirtualChannelRead');
// hChannelHandle : HANDLE -> Pointer<Void>
// TimeOut : DWORD -> Uint32
// Buffer : LPSTR out -> Pointer<Utf8>
// BufferSize : DWORD -> Uint32
// pBytesRead : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WTSVirtualChannelRead(
  hChannelHandle: THandle;   // HANDLE
  TimeOut: DWORD;   // DWORD
  Buffer: PAnsiChar;   // LPSTR out
  BufferSize: DWORD;   // DWORD
  pBytesRead: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WTSAPI32.dll' name 'WTSVirtualChannelRead';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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