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
BufferSizeDWORDin
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 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)。