ホーム › 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
);

パラメーター

名前	型	方向	説明
hChannelHandle	HANDLE	in	WTSVirtualChannelOpen 関数で開いた仮想チャネルへのハンドル。
TimeOut	DWORD	in	タイムアウトをミリ秒単位で指定します。TimeOut が 0 の場合、読み取るデータがなければ WTSVirtualChannelRead は直ちに制御を返します。TimeOut が INFINITE (Winbase.h で定義) の場合、関数は読み取るデータが得られるまで無期限に待機します。
Buffer	LPSTR	out	仮想チャネルのサーバー側から読み取ったデータのチャンクを受け取るバッファーへのポインター。1 回の WTSVirtualChannelRead 呼び出しでサーバーが受け取ることができるデータの最大量は CHANNEL_CHUNK_LENGTH バイトです。クライアントの VirtualChannelWrite 呼び出しがこれより大きいデータブロックを書き込んだ場合、サーバーは WTSVirtualChannelRead を複数回呼び出す必要があります。場合によっては、リモートデスクトップサービスは WTSVirtualChannelRead 関数が読み取る各データチャンクの先頭に CHANNEL_PDU_HEADER 構造体を配置します。これは、クライアント DLL が仮想チャネルを初期化するために VirtualChannelInit 関数を呼び出す際に CHANNEL_OPTION_SHOW_PROTOCOL オプションを設定した場合に発生します。また、そのチャネルが IWTSVirtualChannel::Write メソッドを使用して書き込まれた動的仮想チャネルである場合にも発生します。それ以外の場合、バッファーは VirtualChannelWrite 呼び出しで書き込まれたデータのみを受け取ります。
BufferSize	DWORD	in	Buffer のサイズをバイト単位で指定します。Buffer 内のデータチャンクの前に CHANNEL_PDU_HEADER 構造体が付加される場合、このパラメーターの値は少なくとも CHANNEL_PDU_LENGTH である必要があります。それ以外の場合、このパラメーターの値は少なくとも CHANNEL_CHUNK_LENGTH である必要があります。
pBytesRead	DWORD*	out	読み取られたバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

仮想チャネルのサーバー側からデータを読み取ります。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

注 WTSVirtualChannelRead はスレッドセーフではありません。複数のスレッドから仮想チャネルにアクセスする場合、または仮想チャネルを通じて非同期 I/O を行う場合は、WTSVirtualFileHandle を指定して WTSVirtualChannelQuery を使用してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// 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 方式にも切替可。#uselib "WTSAPI32.dll"
#cfunc global WTSVirtualChannelRead "WTSVirtualChannelRead" sptr, int, sptr, int, sptr
; res = WTSVirtualChannelRead(hChannelHandle, TimeOut, varptr(Buffer), BufferSize, varptr(pBytesRead))
; hChannelHandle : HANDLE -> "sptr"
; TimeOut : DWORD -> "int"
; Buffer : LPSTR out -> "sptr"
; BufferSize : DWORD -> "int"
; pBytesRead : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。