FtpWebRequest.EndGetRequestStream メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

FtpWebRequest.EndGetRequestStream メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

BeginGetRequestStream で開始された保留中の非同期操作を終了します。

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

Visual Basic (宣言)

Public Overrides Function
 EndGetRequestStream ( _
    asyncResult As IAsyncResult _
) As Stream

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim asyncResult As IAsyncResult
Dim returnValue As Stream

returnValue = instance.EndGetRequestStream(asyncResult)

public override Stream EndGetRequestStream (
    IAsyncResult asyncResult
)

C++

public:
virtual Stream^ EndGetRequestStream (
    IAsyncResult^ asyncResult
) override

public Stream EndGetRequestStream (
    IAsyncResult asyncResult
)

JScript

public override function EndGetRequestStream
 (
    asyncResult : IAsyncResult
) : Stream

パラメータ

asyncResult: 操作の開始時に返された IAsyncResult オブジェクト。

戻り値
このインスタンスに関連付けられている、書き込み可能な Stream インスタンス。

例外

例外の種類	条件
ArgumentNullException	asyncResult が null 参照 (Visual Basic では Nothing) です。
ArgumentException	BeginGetRequestStream の呼び出しで、asyncResult が取得されませんでした。
InvalidOperationException	このメソッドは、asyncResult で識別される操作に対して既に呼び出されています。

解説

操作が完了していない場合、EndGetRequestStream メソッドは操作が完了するまでブロックします。操作が完了したかどうかを確認するには、EndGetRequestStream を呼び出す前に、IsCompleted プロパティをチェックします。

「例外」で説明している例外に加えて、EndGetRequestStream は、書き込み用のストリームのオープン時にスローされた例外を再スローします。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

要求のストリームを取得するための非同期操作を終了するコード例を次に示します。このコード例は FtpWebRequest クラスの概要で取り上げているコード例の一部分です。

private static void EndGetStreamCallback(IAsyncResult
 ar)
{
    FtpState state = (FtpState) ar.AsyncState;
    
    Stream requestStream = null;
    // End the asynchronous call to get the request stream.
    try
    {
        requestStream = state.Request.EndGetRequestStream(ar);
        // Copy the file contents to the request stream.
        const int bufferLength = 2048;
        byte[] buffer = new byte[bufferLength];
        int count = 0;
        int readBytes = 0;
        FileStream stream = File.OpenRead(state.FileName);
        do
        {
            readBytes = stream.Read(buffer, 0, bufferLength);
            requestStream.Write(buffer, 0, readBytes);
            count += readBytes;
        }
        while (readBytes != 0);
        Console.WriteLine ("Writing {0} bytes to the stream.", count);
        // IMPORTANT: Close the request stream before sending the request.
        requestStream.Close();
        // Asynchronously get the response to the upload request.
        state.Request.BeginGetResponse(
            new AsyncCallback (EndGetResponseCallback), 
            state
        );
    } 
    // Return exceptions to the main application thread.
    catch (Exception e)
    {
        Console.WriteLine("Could not get the request stream.");
        state.OperationException = e;
        state.OperationComplete.Set();
        return;
    }
   
}

C++

private:
   static void EndGetStreamCallback( IAsyncResult^
 ar )
   {
      FtpState^ state = dynamic_cast<FtpState^>(ar->AsyncState);
      Stream^ requestStream = nullptr;

      // End the asynchronous call to get the request stream.
      try
      {
         requestStream = state->Request->EndGetRequestStream( ar );

         // Copy the file contents to the request stream.
         const int bufferLength = 2048;
         array<Byte>^buffer = gcnew array<Byte>(bufferLength);
         int count = 0;
         int readBytes = 0;
         FileStream^ stream = File::OpenRead( state->FileName );
         do
         {
            readBytes = stream->Read( buffer, 0, bufferLength );
            requestStream->Write( buffer, 0, bufferLength );
            count += readBytes;
         }
         while ( readBytes != 0 );
         Console::WriteLine( "Writing {0} bytes to the stream.", count
 );

         // IMPORTANT: Close the request stream before sending the request.
         requestStream->Close();

         // Asynchronously get the response to the upload request.
         state->Request->BeginGetResponse( gcnew AsyncCallback( EndGetResponseCallback
 ), state );
      }
      // Return exceptions to the main application thread.
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "Could not get the request stream."
 );
         state->OperationException = e;
         state->OperationComplete->Set();
         return;
      }
   }