NetworkStream.EndWrite メソッド

.NET Framework クラス ライブラリ リファレンス

NetworkStream.EndWrite メソッド

非同期書き込みの終了を処理します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Overrides Sub EndWrite
 ( _
    asyncResult As IAsyncResult _
)

Visual Basic (使用法)

Dim instance As NetworkStream
Dim asyncResult As IAsyncResult

instance.EndWrite(asyncResult)

C#

public override void EndWrite (
    IAsyncResult asyncResult
)

C++

public:
virtual void EndWrite (
    IAsyncResult^ asyncResult
) override

J#

public void EndWrite (
    IAsyncResult asyncResult
)

JScript

public override function EndWrite (
    asyncResult : IAsyncResult
)

パラメータ

asyncResult

非同期呼び出しを表す IAsyncResult。

例外

例外の種類	条件
ArgumentNullException	asyncResult が null 参照 (Visual Basic では Nothing) です。
IOException	基になっている Socket が閉じています。 または ネットワークへの書き込み中にエラーが発生しました。 または ソケットへのアクセス中にエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	NetworkStream が閉じています。

解説

EndWrite は、BeginWrite で開始された非同期送信操作を完了します。

BeginWrite を呼び出す前に、AsyncCallback デリゲートを実装するコールバック メソッドを作成する必要があります。このコールバック メソッドは個別のスレッドで実行され、BeginWrite の終了時に呼び出されます。コールバック メソッドは、BeginWrite メソッドからパラメータとして返された IAsyncResult を受け取る必要があります。

コールバック メソッド内では、IAsyncResult パラメータの AsyncState プロパティを呼び出して NetworkStream を取得します。NetworkStream を取得したら、EndWrite メソッドを呼び出して送信操作を正常に完了し、送信されたバイト数を返すことができます。

EndWrite メソッドは、要求されたバイト数が送信されるまでブロックします。

メモ
IOException が発生した場合は、InnerException プロパティをチェックして、この原因が SocketException かどうかを確認してください。その場合、ErrorCode プロパティを使用して特定のエラー コードを取得してください。エラーの詳細については、MSDN で Windows Socket Version 2 API のエラー コードのドキュメントを参照してください。

使用例

myWriteCallback をコールバック メソッドとして BeginWrite に提供し、BeginWrite で開始される非同期書き込みの呼び出しを完了するために、その myWriteCallback に EndWrite を実装するコード例を次に示します。

Visual Basic

Public Shared Sub myWriteCallBack(ar
 As IAsyncResult)
   
   Dim myNetworkStream As NetworkStream = CType(ar.AsyncState,
 NetworkStream)
   myNetworkStream.EndWrite(ar)
End Sub 'myWriteCallBack

C#

public static void myWriteCallBack(IAsyncResult
 ar){

     NetworkStream myNetworkStream = (NetworkStream)ar.AsyncState;
     myNetworkStream.EndWrite(ar);
}

C++

static void myWriteCallBack( IAsyncResult^
 ar )
{
   NetworkStream^ myNetworkStream = safe_cast<NetworkStream^>(ar->AsyncState);
   myNetworkStream->EndWrite( ar );
}

J#

public static void MyWriteCallBack(IAsyncResult
 ar)
{
    NetworkStream myNetworkStream = (NetworkStream)ar.get_AsyncState();
    myNetworkStream.EndWrite(ar);
} //MyWriteCallBack

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
NetworkStream クラス
NetworkStream メンバ
System.Net.Sockets 名前空間
BeginWrite