VIRTUALCHANNELWRITE コールバック関数 (cchannel.h)

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

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

構文

VIRTUALCHANNELWRITE Virtualchannelwrite;

UINT VCAPITYPE Virtualchannelwrite(
  [in] DWORD openHandle,
  [in] LPVOID pData,
  [in] ULONG dataLength,
  [in] LPVOID pUserData
)
{...}

パラメーター

[in] openHandle

仮想チャネルへのハンドル。 これは、VirtualChannelOpen 関数の pOpenHandle パラメーターで返されるハンドルです。

[in] pData

書き込むデータを含むバッファーへのポインター。

[in] dataLength

書き込む pData バッファー内のデータのバイト数を指定します。

[in] pUserData

アプリケーション定義の値。 この値は、書き込み操作が完了または取り消されたときに VirtualChannelOpenEvent 関数に渡されます。

戻り値

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

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

注釈

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

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

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

要件

要件 値
サポートされている最小のクライアント Windows Vista
サポートされている最小のサーバー Windows Server 2008
対象プラットフォーム Windows
ヘッダー cchannel.h

こちらもご覧ください

VirtualChannelOpen

VirtualChannelOpenEvent

WTSVirtualChannelRead