ホーム › System.RemoteDesktop › PVIRTUALCHANNELWRITE

PVIRTUALCHANNELWRITE

コールバック

シグネチャ

DWORD PVIRTUALCHANNELWRITE(
    DWORD openHandle,
    void* pData,
    DWORD dataLength,
    void* pUserData
);

パラメーター

フィールド	型	説明
openHandle	DWORD	仮想チャネルのハンドルです。これは、 VirtualChannelOpen 関数の pOpenHandle パラメーターで返されるハンドルです。
pData	void*	書き込むデータを格納したバッファーへのポインターです。
dataLength	DWORD	書き込む pData バッファー内のデータのバイト数を指定します。
pUserData	void*	アプリケーション定義の値です。この値は、書き込み操作が完了またはキャンセルされたときに、 VirtualChannelOpenEvent 関数に渡されます。

公式ドキュメント

仮想チャネルのクライアント側から、サーバー側のパートナーアプリケーションにデータを送信します。

リモートデスクトップサービスは、 VirtualChannelWrite 関数へのポインターを、 VirtualChannelEntry エントリポイントに渡される CHANNEL_ENTRY_POINTS 構造体で提供します。

戻り値

関数が成功した場合、戻り値は CHANNEL_RC_OK です。

エラーが発生した場合、関数は次のいずれかの値を返します。

解説(Remarks)

VirtualChannelWrite 関数は非同期です。書き込み操作が完了すると、 VirtualChannelOpenEvent 関数が CHANNEL_EVENT_WRITE_COMPLETE 通知を受け取ります。この通知を受け取るまで、呼び出し側は VirtualChannelWrite に渡した pData バッファーを解放したり再利用したりしてはいけません。

pUserData パラメーターに指定した値は、書き込み操作が完了またはキャンセルされたときに VirtualChannelOpenEvent 関数に渡されます。このデータを使用して書き込み操作を識別できます。

仮想チャネルのサーバー側にあるサーバーアドインは、 WTSVirtualChannelRead 関数を呼び出して、 VirtualChannelWrite の呼び出しによって書き込まれたデータを読み取ります。

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